@@ -38,6 +38,7 @@ React component to render markdown.
38
38
* [ ` AllowElement ` ] ( #allowelement )
39
39
* [ ` Components ` ] ( #components )
40
40
* [ ` ExtraProps ` ] ( #extraprops )
41
+ * [ ` HooksOptions ` ] ( #hooksoptions )
41
42
* [ ` Options ` ] ( #options )
42
43
* [ ` UrlTransform ` ] ( #urltransform )
43
44
* [ Examples] ( #examples )
@@ -227,7 +228,7 @@ see [`MarkdownAsync`][api-markdown-async].
227
228
228
229
###### Returns
229
230
230
- React element (` ReactElement ` ).
231
+ React node (` ReactNode ` ).
231
232
232
233
### ` defaultUrlTransform(url) `
233
234
@@ -283,6 +284,20 @@ Extra fields we pass to components (TypeScript type).
283
284
* ` node ` ([ ` Element ` from ` hast ` ][github-hast-element], optional)
284
285
— original node
285
286
287
+ ### ` HooksOptions `
288
+
289
+ Configuration for [ ` MarkdownHooks ` ][api-markdown-hooks] (TypeScript type);
290
+ extends the regular [ ` Options ` ][api-options] with a ` fallback ` prop.
291
+
292
+ ###### Extends
293
+
294
+ [ ` Options ` ][api-options].
295
+
296
+ ###### Fields
297
+
298
+ * ` fallback ` ( ` ReactNode ` , optional)
299
+ — content to render while the processor processing the markdown
300
+
286
301
### ` Options `
287
302
288
303
Configuration (TypeScript type).
@@ -583,8 +598,9 @@ extensions.
583
598
This package is fully typed with [TypeScript][].
584
599
It exports the additional types
585
600
[ ` AllowElement ` ][api-allow-element],
586
- [ ` ExtraProps ` ][api-extra-props],
587
601
[ ` Components ` ][api-components],
602
+ [ ` ExtraProps ` ][api-extra-props],
603
+ [ ` HooksOptions ` ][api-hooks-options],
588
604
[ ` Options ` ][api-options], and
589
605
[ ` UrlTransform ` ][api-url-transform].
590
606
@@ -816,6 +832,8 @@ abide by its terms.
816
832
817
833
[api - extra - props ]: #extraprops
818
834
835
+ [api - hooks - options ]: #hooksoptions
836
+
819
837
[api - markdown ]: #markdown
820
838
821
839
[api - markdown - async ]: #markdownasync
0 commit comments