Debian Codegraph @

packages/lit-starter-ts/docs/api/index.html

raw
1
2 <!doctype html>
3
4 <html lang="en">
5 <head>
6 <meta charset="utf-8">
7 <meta name="viewport" content="width=device-width, initial-scale=1.0">
8 <title><my-element> ⌲ Docs</title>
9 <link rel="stylesheet" href="../docs.css">
10 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600|Roboto+Mono">
11 <link href="../prism-okaidia.css" rel="stylesheet" />
12 <script src="/node_modules/@webcomponents/webcomponentsjs/webcomponents-loader.js"></script>
13 <script src="/node_modules/lit/polyfill-support.js"></script>
14 <script type="module" src="../my-element.bundled.js"></script>
15 </head>
16 <body>
17
18 <header>
19 <h1>&lt;my-element></h1>
20 <h2>A web component just for me.</h2>
21 </header>
22
23 <nav>
24 <a href="../">Home</a>
25 <a href="../examples/">Examples</a>
26 <a href="">API</a>
27 <a href="../install/">Install</a>
28 </nav>
29 <div id="main-wrapper">
30 <main>
31
32 <h1>API</h1>
33
34 <h2>&lt;my-element></h2>
35 <div>
36 An example element.
37 </div>
38
39 <h3>Attributes</h3>
40 <table>
41 <tr>
42 <th>Name</th><th>Description</th><th>Type</th><th>Default</th>
43 </tr>
44
45 <tr>
46 <td>name</td><td>The name to say "Hello" to.</td><td>string</td><td>'World'</td>
47 </tr>
48
49 <tr>
50 <td>count</td><td>The number of times the button has been clicked.</td><td>number</td><td>0</td>
51 </tr>
52
53 </table>
54
55
56 <h3>Properties</h3>
57 <table>
58 <tr>
59 <th>Name</th><th>Attribute</th><th>Description</th><th>Type</th><th>Default</th>
60 </tr>
61
62 <tr>
63 <td>name</td><td>name</td><td>The name to say "Hello" to.</td><td>string</td><td>'World'</td>
64 </tr>
65
66 <tr>
67 <td>count</td><td>count</td><td>The number of times the button has been clicked.</td><td>number</td><td>0</td>
68 </tr>
69
70 </table>
71
72
73 <h3>Methods</h3>
74 <table>
75 <tr>
76 <th>Name</th><th>Parameters</th><th>Description</th><th>Return</th>
77 </tr>
78
79 <tr>
80 <td>sayHello</td><td>
81
82 <table>
83 <tr>
84 <th>Name</th><th>Description</th><th>Type</th>
85 </tr>
86
87 <tr>
88 <td>name</td><td>The name to say "Hello" to</td><td>string</td>
89 </tr>
90
91 </table>
92 </td><td>Formats a greeting</td><td>string</td>
93 </tr>
94
95 </table>
96
97
98 <h3>Events</h3>
99 <table>
100 <tr>
101 <th>Name</th><th>Description</th>
102 </tr>
103
104 <tr>
105 <td>count-changed</td><td>Indicates when the count changes</td>
106 </tr>
107
108 </table>
109
110
111 <h3>Slots</h3>
112 <table>
113 <tr>
114 <th>Name</th><th>Description</th>
115 </tr>
116
117 <tr>
118 <td>(default)</td><td>This element has a slot</td>
119 </tr>
120
121 </table>
122
123
124 <h3>CSS Shadow Parts</h3>
125 <table>
126 <tr>
127 <th>Name</th><th>Description</th>
128 </tr>
129
130 <tr>
131 <td>button</td><td>The button</td>
132 </tr>
133
134 </table>
135
136
137
138
139 </main>
140 </div>
141
142 <footer>
143 <p>
144 Made with
145 <a href="https://github.com/lit/lit-element-starter-ts">lit-starter-ts</a>
146 </p>
147 </footer>
148 </body>
149 </html>