Skip to content

Commit 56d8336

Browse files
committed
Refactor definition casing
1 parent c9889fc commit 56d8336

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

readme.md

+29-27
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Yields:
104104

105105
## API
106106

107-
This package exports the identifier [`toJsxRuntime`][tojsxruntime].
107+
This package exports the identifier [`toJsxRuntime`][api-to-jsx-runtime].
108108
There is no default export.
109109

110110
### `toJsxRuntime(tree, options)`
@@ -116,7 +116,7 @@ automatic JSX runtime.
116116

117117
* `tree` ([`Node`][node])
118118
— tree to transform
119-
* `options` ([`Options`][options], required)
119+
* `options` ([`Options`][api-options], required)
120120
— configuration
121121

122122
###### Returns
@@ -131,19 +131,19 @@ Configuration (TypeScript type).
131131

132132
###### `Fragment`
133133

134-
Fragment ([`Fragment`][fragment], required).
134+
Fragment ([`Fragment`][api-fragment], required).
135135

136136
###### `jsx`
137137

138-
Dynamic JSX ([`Jsx`][jsx], required in production).
138+
Dynamic JSX ([`Jsx`][api-jsx], required in production).
139139

140140
###### `jsxs`
141141

142-
Static JSX ([`Jsx`][jsx], required in production).
142+
Static JSX ([`Jsx`][api-jsx], required in production).
143143

144144
###### `jsxDEV`
145145

146-
Development JSX ([`JsxDev`][jsxdev], required in development).
146+
Development JSX ([`JsxDev`][api-jsx-dev], required in development).
147147

148148
###### `development`
149149

@@ -152,7 +152,7 @@ default: `false`).
152152

153153
###### `components`
154154

155-
Components to use ([`Partial<Components>`][components], optional).
155+
Components to use ([`Partial<Components>`][api-components], optional).
156156

157157
Each key is the name of an HTML (or SVG) element to override.
158158
The value is the component to render instead.
@@ -167,16 +167,17 @@ Passed in source info to `jsxDEV` when using the automatic runtime with
167167
###### `elementAttributeNameCase`
168168

169169
Specify casing to use for attribute names
170-
([`ElementAttributeNameCase`][elementattributenamecase], default: `'react'`).
170+
([`ElementAttributeNameCase`][api-element-attribute-name-case], default:
171+
`'react'`).
171172

172173
###### `passNode`
173174

174175
Pass the hast element node to components (`boolean`, default: `false`).
175176

176177
###### `space`
177178

178-
Whether `tree` is in the `'html'` or `'svg'` space ([`Space`][space], default:
179-
`'html'`).
179+
Whether `tree` is in the `'html'` or `'svg'` space ([`Space`][api-space],
180+
default: `'html'`).
180181

181182
When an `<svg>` element is found in the HTML space, this package already
182183
automatically switches to and from the SVG space when entering and exiting
@@ -250,7 +251,7 @@ Create a production element (TypeScript type).
250251
251252
* `type` (`unknown`)
252253
— element type: `Fragment` symbol, tag name (`string`), component
253-
* `props` ([`Props`][props])
254+
* `props` ([`Props`][api-props])
254255
— element props, `children`, and maybe `node`
255256
* `key` (`string` or `undefined`)
256257
— dynamicly generated key to use
@@ -267,13 +268,13 @@ Create a development element (TypeScript type).
267268
268269
* `type` (`unknown`)
269270
— element type: `Fragment` symbol, tag name (`string`), component
270-
* `props` ([`Props`][props])
271+
* `props` ([`Props`][api-props])
271272
— element props, `children`, and maybe `node`
272273
* `key` (`string` or `undefined`)
273274
— dynamicly generated key to use
274275
* `isStaticChildren` (`boolean`)
275276
— whether more than one children are used
276-
* `source` ([`Source`][source])
277+
* `source` ([`Source`][api-source])
277278
— info about source
278279
* `self` (`undefined`)
279280
— nothing (this is used by frameworks that have components, we don’t)
@@ -415,10 +416,11 @@ followed by browsers such as Chrome, Firefox, and Safari.
415416
## Types
416417

417418
This package is fully typed with [TypeScript][].
418-
It exports the additional types [`Components`][components],
419-
[`ElementAttributeNameCase`][elementattributenamecase],
420-
[`Fragment`][fragment], [`Jsx`][jsx], [`JsxDev`][jsxdev], [`Options`][options],
421-
[`Props`][props], [`Source`][source], and [`Space`][Space].
419+
It exports the additional types [`Components`][api-components],
420+
[`ElementAttributeNameCase`][api-element-attribute-name-case],
421+
[`Fragment`][api-fragment], [`Jsx`][api-jsx], [`JsxDev`][api-jsx-dev],
422+
[`Options`][api-options], [`Props`][api-props], [`Source`][api-source],
423+
and [`Space`][api-Space].
422424

423425
The function `toJsxRuntime` returns a `JSX.Element`, which means that the JSX
424426
namespace has to by typed.
@@ -516,22 +518,22 @@ abide by its terms.
516518

517519
[jsx-runtime]: https://reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html
518520

519-
[options]: #options
521+
[api-to-jsx-runtime]: #tojsxruntimetree-options
520522

521-
[tojsxruntime]: #tojsxruntimetree-options
523+
[api-components]: #components-1
522524

523-
[fragment]: #fragment-1
525+
[api-element-attribute-name-case]: #elementattributenamecase-1
524526

525-
[jsx]: #jsx-1
527+
[api-fragment]: #fragment-1
526528

527-
[jsxdev]: #jsxdev-1
529+
[api-jsx]: #jsx-1
528530

529-
[props]: #props
531+
[api-jsx-dev]: #jsxdev-1
530532

531-
[source]: #source
533+
[api-options]: #options
532534

533-
[space]: #space-1
535+
[api-props]: #props
534536

535-
[components]: #components-1
537+
[api-source]: #source
536538

537-
[elementattributenamecase]: #elementattributenamecase-1
539+
[api-space]: #space-1

0 commit comments

Comments
 (0)