generated from lit/lit-element-starter-ts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
custom-elements.json
215 lines (215 loc) · 7.32 KB
/
custom-elements.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
{
"schemaVersion": "1.0.0",
"readme": "",
"modules": [
{
"kind": "javascript-module",
"path": "src/toc-observer.ts",
"declarations": [
{
"kind": "class",
"description": "<toc-observer> highlights elements in a table of contents\nif their counterparts are visible in the viewport.",
"name": "TocObserver",
"slots": [
{
"description": "place for your table of contents Copyright © 2023 Tony Spegel",
"name": "toc"
},
{
"description": "ul/ol with #-links",
"name": "toc"
}
],
"members": [
{
"kind": "field",
"name": "tocActiveClass",
"type": {
"text": "string"
},
"privacy": "public",
"default": "'toc-active'",
"attribute": "tocActiveClass"
},
{
"kind": "field",
"name": "rootElement",
"type": {
"text": "string | undefined"
},
"privacy": "public",
"attribute": "rootElement"
},
{
"kind": "field",
"name": "rootMargin",
"type": {
"text": "string"
},
"privacy": "public",
"default": "'0px'",
"attribute": "rootMargin"
},
{
"kind": "field",
"name": "observeParent",
"type": {
"text": "boolean"
},
"privacy": "public",
"default": "false",
"description": "Useful for observing nested markup like this:\n<section>\n <!-- ^observe -->\n <h2 id=\"possum\">Possum</h2>\n</section>\n\nObserving wrapper elements instead of just headings\nhas the advantage that those have more area to intersect with.\n\n ┌─────────┐\n │ #possum │\n ┌─┼─────────┼─┐\n │ │ │ │\n │ └─────────┘ │< Viewport\n │ ^section │\n └─────────────┘",
"attribute": "observeParent"
},
{
"kind": "field",
"name": "parentSelector",
"type": {
"text": "string"
},
"privacy": "public",
"default": "'section'",
"attribute": "parentSelector"
},
{
"kind": "field",
"name": "_tocList",
"type": {
"text": "Array<HTMLUListElement> | undefined"
},
"privacy": "private"
},
{
"kind": "field",
"name": "anchorHashObserverMap",
"type": {
"text": "Map<\n HTMLAnchorElement['hash'],\n IntersectionObserver\n >"
},
"privacy": "private"
},
{
"kind": "method",
"name": "selectTocLink",
"privacy": "private",
"return": {
"type": {
"text": "HTMLAnchorElement | null"
}
},
"parameters": [
{
"name": "id",
"type": {
"text": "string"
}
}
],
"description": "Selects a TOC link within the components slot / ul element.\nIts id param is obtained by reading the oberver item's target-id."
},
{
"kind": "field",
"name": "_tocListItems",
"type": {
"text": "HTMLAnchorElement[] | null"
},
"privacy": "private",
"description": "Receive any items within '_tocList' if present or null"
},
{
"kind": "method",
"name": "createIdObserverMap",
"privacy": "private",
"return": {
"type": {
"text": "Map<HTMLAnchorElement['hash'], IntersectionObserver>"
}
},
"parameters": [
{
"name": "anchors",
"type": {
"text": "HTMLAnchorElement[]"
}
}
],
"description": "Creates a map of anchor-IDs and their corresponding\nIntersectionObservers. Anchor-IDs are used to select\ntoc-links within '_tocList' and also to create observer\nitems later.\n\n{\"#beschreibung\" => IntersectionObserver}\n{\"#lebensweise\" => IntersectionObserver}"
}
],
"attributes": [
{
"name": "tocActiveClass",
"type": {
"text": "string"
},
"default": "'toc-active'",
"fieldName": "tocActiveClass"
},
{
"name": "rootElement",
"type": {
"text": "string | undefined"
},
"fieldName": "rootElement"
},
{
"name": "rootMargin",
"type": {
"text": "string"
},
"default": "'0px'",
"fieldName": "rootMargin"
},
{
"name": "observeParent",
"type": {
"text": "boolean"
},
"default": "false",
"description": "Useful for observing nested markup like this:\n<section>\n <!-- ^observe -->\n <h2 id=\"possum\">Possum</h2>\n</section>\n\nObserving wrapper elements instead of just headings\nhas the advantage that those have more area to intersect with.\n\n ┌─────────┐\n │ #possum │\n ┌─┼─────────┼─┐\n │ │ │ │\n │ └─────────┘ │< Viewport\n │ ^section │\n └─────────────┘",
"fieldName": "observeParent"
},
{
"name": "parentSelector",
"type": {
"text": "string"
},
"default": "'section'",
"fieldName": "parentSelector"
}
],
"superclass": {
"name": "LitElement",
"package": "lit"
},
"summary": "highlights elements in a table of contents\nif their counterparts are visible in the viewport.",
"tagName": "toc-observer",
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "TocObserver",
"declaration": {
"name": "TocObserver",
"module": "src/toc-observer.ts"
}
},
{
"kind": "custom-element-definition",
"name": "toc-observer",
"declaration": {
"name": "TocObserver",
"module": "src/toc-observer.ts"
}
}
]
},
{
"kind": "javascript-module",
"path": "src/test/toc-observer_test.ts",
"declarations": [],
"exports": []
}
]
}