139 lines
3.7 KiB
HTML
139 lines
3.7 KiB
HTML
|
|
<!doctype html>
|
|
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title><my-element> ⌲ Docs</title>
|
|
<link rel="stylesheet" href="../docs.css">
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600|Roboto+Mono">
|
|
<link href="../prism-okaidia.css" rel="stylesheet" />
|
|
<script src="/node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>
|
|
<script src="/node_modules/lit/polyfill-support.js"></script>
|
|
<script type="module" src="../my-element.bundled.js"></script>
|
|
</head>
|
|
<body>
|
|
|
|
<header>
|
|
<h1><my-element></h1>
|
|
<h2>A web component just for me.</h2>
|
|
</header>
|
|
|
|
<nav>
|
|
<a href="../">Home</a>
|
|
<a href="../examples/">Examples</a>
|
|
<a href="">API</a>
|
|
<a href="../install/">Install</a>
|
|
</nav>
|
|
<div id="main-wrapper">
|
|
<main>
|
|
|
|
<h1>API</h1>
|
|
|
|
<h2><my-element></h2>
|
|
<div>
|
|
An example element.
|
|
</div>
|
|
|
|
<h3>Attributes</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Name</th><th>Description</th><th>Type</th><th>Default</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>name</td><td>The name to say "Hello" to.</td><td>string</td><td>"World"</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>count</td><td>The number of times the button has been clicked.</td><td>number</td><td>0</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
<h3>Properties</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Name</th><th>Attribute</th><th>Description</th><th>Type</th><th>Default</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>name</td><td>name</td><td>The name to say "Hello" to.</td><td>string</td><td>"World"</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>count</td><td>count</td><td>The number of times the button has been clicked.</td><td>number</td><td>0</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>renderRoot</td><td>undefined</td><td>Node or ShadowRoot into which element DOM should be rendered. Defaults
|
|
to an open shadowRoot.</td><td>HTMLElement | ShadowRoot</td><td>undefined</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>isUpdatePending</td><td>undefined</td><td>undefined</td><td>boolean</td><td>undefined</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>hasUpdated</td><td>undefined</td><td>undefined</td><td>boolean</td><td>undefined</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>updateComplete</td><td>undefined</td><td>Returns a Promise that resolves when the element has completed updating.
|
|
The Promise value is a boolean that is `true` if the element completed the
|
|
update without triggering another update. The Promise result is `false` if
|
|
a property was set inside `updated()`. If the Promise is rejected, an
|
|
exception was thrown during the update.
|
|
|
|
To await additional asynchronous work, override the `getUpdateComplete`
|
|
method. For example, it is sometimes useful to await a rendered element
|
|
before fulfilling this Promise. To do this, first await
|
|
`super.getUpdateComplete()`, then any subsequent state.</td><td>Promise<boolean></td><td>undefined</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h3>Slots</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Name</th><th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td></td><td>This element has a slot</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
<h3>CSS Shadow Parts</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Name</th><th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>button</td><td>The button</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
</main>
|
|
</div>
|
|
|
|
<footer>
|
|
<p>
|
|
Made with
|
|
<a href="https://github.com/PolymerLabs/lit-starter-ts">lit-starter-ts</a>
|
|
</p>
|
|
</footer>
|
|
</body>
|
|
</html> |