@@ -13,35 +13,35 @@ with an automatic JSX runtime.
13
13
14
14
## Contents
15
15
16
- * [ What is this?] ( #what-is-this )
17
- * [ When should I use this?] ( #when-should-i-use-this )
18
- * [ Install] ( #install )
19
- * [ Use] ( #use )
20
- * [ API] ( #api )
21
- * [ ` toJsxRuntime(tree, options) ` ] ( #tojsxruntimetree-options )
22
- * [ ` Options ` ] ( #options )
23
- * [ ` Components ` ] ( #components )
24
- * [ ` ElementAttributeNameCase ` ] ( #elementattributenamecase )
25
- * [ ` ExtraProps ` ] ( #extraprops )
26
- * [ ` Fragment ` ] ( #fragment )
27
- * [ ` Jsx ` ] ( #jsx )
28
- * [ ` JsxDev ` ] ( #jsxdev )
29
- * [ ` Props ` ] ( #props )
30
- * [ ` Source ` ] ( #source )
31
- * [ ` Space ` ] ( #space )
32
- * [ ` StylePropertyNameCase ` ] ( #stylepropertynamecase )
33
- * [ Examples] ( #examples )
34
- * [ Example: Preact] ( #example-preact )
35
- * [ Example: Vue] ( #example-vue )
36
- * [ Example: Solid] ( #example-solid )
37
- * [ Example: Svelte] ( #example-svelte )
38
- * [ Syntax] ( #syntax )
39
- * [ Types] ( #types )
40
- * [ Compatibility] ( #compatibility )
41
- * [ Security] ( #security )
42
- * [ Related] ( #related )
43
- * [ Contribute] ( #contribute )
44
- * [ License] ( #license )
16
+ * [ What is this?] ( #what-is-this )
17
+ * [ When should I use this?] ( #when-should-i-use-this )
18
+ * [ Install] ( #install )
19
+ * [ Use] ( #use )
20
+ * [ API] ( #api )
21
+ * [ ` toJsxRuntime(tree, options) ` ] ( #tojsxruntimetree-options )
22
+ * [ ` Options ` ] ( #options )
23
+ * [ ` Components ` ] ( #components )
24
+ * [ ` ElementAttributeNameCase ` ] ( #elementattributenamecase )
25
+ * [ ` ExtraProps ` ] ( #extraprops )
26
+ * [ ` Fragment ` ] ( #fragment )
27
+ * [ ` Jsx ` ] ( #jsx )
28
+ * [ ` JsxDev ` ] ( #jsxdev )
29
+ * [ ` Props ` ] ( #props )
30
+ * [ ` Source ` ] ( #source )
31
+ * [ ` Space ` ] ( #space )
32
+ * [ ` StylePropertyNameCase ` ] ( #stylepropertynamecase )
33
+ * [ Examples] ( #examples )
34
+ * [ Example: Preact] ( #example-preact )
35
+ * [ Example: Vue] ( #example-vue )
36
+ * [ Example: Solid] ( #example-solid )
37
+ * [ Example: Svelte] ( #example-svelte )
38
+ * [ Syntax] ( #syntax )
39
+ * [ Types] ( #types )
40
+ * [ Compatibility] ( #compatibility )
41
+ * [ Security] ( #security )
42
+ * [ Related] ( #related )
43
+ * [ Contribute] ( #contribute )
44
+ * [ License] ( #license )
45
45
46
46
## What is this?
47
47
@@ -116,10 +116,10 @@ automatic JSX runtime.
116
116
117
117
##### Parameters
118
118
119
- * ` tree ` ([ ` Node ` ] [ node ] )
120
- — tree to transform
121
- * ` options ` ([ ` Options ` ] [ api-options ] , required)
122
- — configuration
119
+ * ` tree ` ([ ` Node ` ] [ node ] )
120
+ — tree to transform
121
+ * ` options ` ([ ` Options ` ] [ api-options ] , required)
122
+ — configuration
123
123
124
124
##### Returns
125
125
@@ -180,38 +180,38 @@ Configuration (TypeScript type).
180
180
181
181
###### Fields
182
182
183
- * ` Fragment ` ([ ` Fragment ` ] [ api-fragment ] , required)
184
- — fragment
185
- * ` jsx ` ([ ` Jsx ` ] [ api-jsx ] , required in production)
186
- — dynamic JSX
187
- * ` jsxs ` ([ ` Jsx ` ] [ api-jsx ] , required in production)
188
- — static JSX
189
- * ` jsxDEV ` ([ ` JsxDev ` ] [ api-jsx-dev ] , required in development)
190
- — development JSX
191
- * ` components ` ([ ` Partial<Components> ` ] [ api-components ] , optional)
192
- — components to use
193
- * ` development ` (` boolean ` , default: ` false ` )
194
- — whether to use ` jsxDEV ` when on or ` jsx ` and ` jsxs ` when off
195
- * ` elementAttributeNameCase `
196
- ([ ` ElementAttributeNameCase ` ] [ api-element-attribute-name-case ] ,
197
- default: ` 'react' ` )
198
- — specify casing to use for attribute names
199
- * ` filePath ` (` string ` , optional)
200
- — file path to the original source file, passed in source info to ` jsxDEV `
201
- when using the automatic runtime with ` development: true `
202
- * ` passNode ` (` boolean ` , default: ` false ` )
203
- — pass the hast element node to components
204
- * ` space ` ([ ` Space ` ] [ api-space ] , default: ` 'html' ` )
205
- — whether ` tree ` is in the ` 'html' ` or ` 'svg' ` space, when an ` <svg> `
206
- element is found in the HTML space, this package already automatically
207
- switches to and from the SVG space when entering and exiting it
208
- * ` stylePropertyNameCase `
209
- ([ ` StylePropertyNameCase ` ] [ api-style-property-name-case ] ,
210
- default: ` 'dom' ` )
211
- — specify casing to use for property names in ` style ` objects
212
- * ` tableCellAlignToStyle `
213
- (` boolean ` , default: ` true ` )
214
- — turn obsolete ` align ` props on ` td ` and ` th ` into CSS ` style ` props
183
+ * ` Fragment ` ([ ` Fragment ` ] [ api-fragment ] , required)
184
+ — fragment
185
+ * ` jsx ` ([ ` Jsx ` ] [ api-jsx ] , required in production)
186
+ — dynamic JSX
187
+ * ` jsxs ` ([ ` Jsx ` ] [ api-jsx ] , required in production)
188
+ — static JSX
189
+ * ` jsxDEV ` ([ ` JsxDev ` ] [ api-jsx-dev ] , required in development)
190
+ — development JSX
191
+ * ` components ` ([ ` Partial<Components> ` ] [ api-components ] , optional)
192
+ — components to use
193
+ * ` development ` (` boolean ` , default: ` false ` )
194
+ — whether to use ` jsxDEV ` when on or ` jsx ` and ` jsxs ` when off
195
+ * ` elementAttributeNameCase `
196
+ ([ ` ElementAttributeNameCase ` ] [ api-element-attribute-name-case ] ,
197
+ default: ` 'react' ` )
198
+ — specify casing to use for attribute names
199
+ * ` filePath ` (` string ` , optional)
200
+ — file path to the original source file, passed in source info to ` jsxDEV `
201
+ when using the automatic runtime with ` development: true `
202
+ * ` passNode ` (` boolean ` , default: ` false ` )
203
+ — pass the hast element node to components
204
+ * ` space ` ([ ` Space ` ] [ api-space ] , default: ` 'html' ` )
205
+ — whether ` tree ` is in the ` 'html' ` or ` 'svg' ` space, when an ` <svg> `
206
+ element is found in the HTML space, this package already automatically
207
+ switches to and from the SVG space when entering and exiting it
208
+ * ` stylePropertyNameCase `
209
+ ([ ` StylePropertyNameCase ` ] [ api-style-property-name-case ] ,
210
+ default: ` 'dom' ` )
211
+ — specify casing to use for property names in ` style ` objects
212
+ * ` tableCellAlignToStyle `
213
+ (` boolean ` , default: ` true ` )
214
+ — turn obsolete ` align ` props on ` td ` and ` th ` into CSS ` style ` props
215
215
216
216
### ` Components `
217
217
@@ -283,12 +283,12 @@ Create a production element (TypeScript type).
283
283
284
284
###### Parameters
285
285
286
- * ` type ` ( ` unknown ` )
287
- — element type: ` Fragment ` symbol, tag name ( ` string ` ), component
288
- * ` props ` ([ ` Props ` ][api-props])
289
- — element props, ` children ` , and maybe ` node `
290
- * ` key ` ( ` string ` or ` undefined ` )
291
- — dynamicly generated key to use
286
+ * ` type ` ( ` unknown ` )
287
+ — element type: ` Fragment ` symbol, tag name ( ` string ` ), component
288
+ * ` props ` ([ ` Props ` ][api-props])
289
+ — element props, ` children ` , and maybe ` node `
290
+ * ` key ` ( ` string ` or ` undefined ` )
291
+ — dynamicly generated key to use
292
292
293
293
###### Returns
294
294
@@ -300,19 +300,19 @@ Create a development element (TypeScript type).
300
300
301
301
###### Parameters
302
302
303
- * ` type ` ( ` unknown ` )
304
- — element type: ` Fragment ` symbol, tag name ( ` string ` ), component
305
- * ` props ` ([ ` Props ` ][api-props])
306
- — element props, ` children ` , and maybe ` node `
307
- * ` key ` ( ` string ` or ` undefined ` )
308
- — dynamicly generated key to use
309
- * ` isStaticChildren ` ( ` boolean ` )
310
- — whether two or more children are passed (in an array), which is whether
311
- ` jsxs ` or ` jsx ` would be used
312
- * ` source ` ([ ` Source ` ][api-source])
313
- — info about source
314
- * ` self ` ( ` undefined ` )
315
- — nothing (this is used by frameworks that have components, we don’t)
303
+ * ` type ` ( ` unknown ` )
304
+ — element type: ` Fragment ` symbol, tag name ( ` string ` ), component
305
+ * ` props ` ([ ` Props ` ][api-props])
306
+ — element props, ` children ` , and maybe ` node `
307
+ * ` key ` ( ` string ` or ` undefined ` )
308
+ — dynamicly generated key to use
309
+ * ` isStaticChildren ` ( ` boolean ` )
310
+ — whether two or more children are passed (in an array), which is whether
311
+ ` jsxs ` or ` jsx ` would be used
312
+ * ` source ` ([ ` Source ` ][api-source])
313
+ — info about source
314
+ * ` self ` ( ` undefined ` )
315
+ — nothing (this is used by frameworks that have components, we don’t)
316
316
317
317
###### Returns
318
318
@@ -347,12 +347,12 @@ Info about source (TypeScript type).
347
347
348
348
###### Fields
349
349
350
- * ` columnNumber ` ( ` number ` or ` undefined ` )
351
- — column where thing starts (0-indexed)
352
- * ` fileName ` ( ` string ` or ` undefined ` )
353
- — name of source file
354
- * ` lineNumber ` ( ` number ` or ` undefined ` )
355
- — line where thing starts (1-indexed)
350
+ * ` columnNumber ` ( ` number ` or ` undefined ` )
351
+ — column where thing starts (0-indexed)
352
+ * ` fileName ` ( ` string ` or ` undefined ` )
353
+ — name of source file
354
+ * ` lineNumber ` ( ` number ` or ` undefined ` )
355
+ — line where thing starts (1-indexed)
356
356
357
357
### ` Space `
358
358
@@ -600,12 +600,12 @@ Use [`hast-util-santize`][hast-util-sanitize] to make hast trees safe.
600
600
601
601
## Related
602
602
603
- * [ ` hastscript ` ] ( https://github.com/syntax-tree/hastscript )
604
- — build hast trees
605
- * [ ` hast-util-to-html ` ] ( https://github.com/syntax-tree/hast-util-to-html )
606
- — serialize hast as HTML
607
- * [ ` hast-util-sanitize ` ] ( https://github.com/syntax-tree/hast-util-sanitize )
608
- — sanitize hast
603
+ * [ ` hastscript ` ] ( https://github.com/syntax-tree/hastscript )
604
+ — build hast trees
605
+ * [ ` hast-util-to-html ` ] ( https://github.com/syntax-tree/hast-util-to-html )
606
+ — serialize hast as HTML
607
+ * [ ` hast-util-sanitize ` ] ( https://github.com/syntax-tree/hast-util-sanitize )
608
+ — sanitize hast
609
609
610
610
## Contribute
611
611
0 commit comments