Skip to content

Commit dfda08e

Browse files
- Updated docs libraries, including fixing up .md files that caused problems with the latest version of Docusaurus
1 parent a3514eb commit dfda08e

File tree

17 files changed

+7328
-3368
lines changed

17 files changed

+7328
-3368
lines changed

package-lock.json

Lines changed: 7130 additions & 3173 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/docs/docs/advanced-customization/custom-templates.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ function ArrayFieldTemplate(props: ArrayFieldTemplateProps) {
7474

7575
render(
7676
<Form schema={schema} validator={validator} templates={{ ArrayFieldTemplate }} />,
77-
document.getElementById('app')
77+
document.getElementById('app'),
7878
);
7979
```
8080

@@ -161,7 +161,7 @@ function ArrayFieldDescriptionTemplate(props: ArrayFieldDescriptionProps) {
161161

162162
render(
163163
<Form schema={schema} validator={validator} templates={{ ArrayFieldDescriptionTemplate }} />,
164-
document.getElementById('app')
164+
document.getElementById('app'),
165165
);
166166
```
167167

@@ -208,7 +208,7 @@ function ArrayFieldItemTemplate(props: ArrayFieldItemTemplateType) {
208208

209209
render(
210210
<Form schema={schema} validator={validator} templates={{ ArrayFieldItemTemplate }} />,
211-
document.getElementById('app')
211+
document.getElementById('app'),
212212
);
213213
```
214214

@@ -267,7 +267,7 @@ function ArrayFieldItemButtonsTemplate(props: ArrayFieldTemplateItemButtonsType)
267267

268268
render(
269269
<Form schema={schema} validator={validator} templates={{ ArrayFieldItemButtonsTemplate }} />,
270-
document.getElementById('app')
270+
document.getElementById('app'),
271271
);
272272
```
273273

@@ -318,7 +318,7 @@ function ArrayFieldTitleTemplate(props: ArrayFieldTitleProps) {
318318

319319
render(
320320
<Form schema={schema} validator={validator} templates={{ ArrayFieldTitleTemplate }} />,
321-
document.getElementById('app')
321+
document.getElementById('app'),
322322
);
323323
```
324324

@@ -419,7 +419,7 @@ function BaseInputTemplate(props: BaseInputTemplateProps) {
419419

420420
render(
421421
<Form schema={schema} validator={validator} templates={{ BaseInputTemplate }} />,
422-
document.getElementById('app')
422+
document.getElementById('app'),
423423
);
424424
```
425425

@@ -465,7 +465,7 @@ The following props are passed to the `BaseInputTemplate`:
465465
- `onBlur`: The input blur event handler; call it with the widget id and value;
466466
- `onFocus`: The input focus event handler; call it with the widget id and value;
467467
- `options`: A map of options passed as a prop to the component (see [Custom widget options](./custom-widgets-fields.md#custom-widget-options)).
468-
- `options.enumOptions`: For enum fields, this property contains the list of options for the enum as an array of { label, value } objects. If the enum is defined using the oneOf/anyOf syntax, the entire schema object for each option is appended onto the { schema, label, value } object.
468+
- `options.enumOptions`: For enum fields, this property contains the list of options for the enum as an array of \{ label, value } objects. If the enum is defined using the oneOf/anyOf syntax, the entire schema object for each option is appended onto the \{ schema, label, value } object.
469469
- `formContext`: The `formContext` object that you passed to `Form`.
470470
- `rawErrors`: An array of strings listing all generated error messages from encountered errors for this widget.
471471
- `registry`: The `registry` object
@@ -497,7 +497,7 @@ function DescriptionFieldTemplate(props: DescriptionFieldProps) {
497497

498498
render(
499499
<Form schema={schema} validator={validator} templates={{ DescriptionFieldTemplate }} />,
500-
document.getElementById('app')
500+
document.getElementById('app'),
501501
);
502502
```
503503

@@ -545,7 +545,7 @@ function ErrorListTemplate(props: ErrorListProps) {
545545

546546
render(
547547
<Form schema={schema} validator={validator} templates={{ ErrorListTemplate }} />,
548-
document.getElementById('app')
548+
document.getElementById('app'),
549549
);
550550
```
551551

@@ -592,7 +592,7 @@ function FieldErrorTemplate(props: FieldErrorProps) {
592592

593593
render(
594594
<Form schema={schema} validator={validator} templates={{ FieldErrorTemplate }} />,
595-
document.getElementById('app')
595+
document.getElementById('app'),
596596
);
597597
```
598598

@@ -628,7 +628,7 @@ function FieldHelpTemplate(props: FieldHelpProps) {
628628

629629
render(
630630
<Form schema={schema} validator={validator} templates={{ FieldHelpTemplate }} />,
631-
document.getElementById('app')
631+
document.getElementById('app'),
632632
);
633633
```
634634

@@ -672,7 +672,7 @@ function CustomFieldTemplate(props: FieldTemplateProps) {
672672

673673
render(
674674
<Form schema={schema} validator={validator} templates={{ FieldTemplate: CustomFieldTemplate }} />,
675-
document.getElementById('app')
675+
document.getElementById('app'),
676676
);
677677
```
678678

@@ -785,7 +785,7 @@ function ObjectFieldTemplate(props: ObjectFieldTemplateProps) {
785785

786786
render(
787787
<Form schema={schema} validator={validator} templates={{ ObjectFieldTemplate }} />,
788-
document.getElementById('app')
788+
document.getElementById('app'),
789789
);
790790
```
791791

@@ -856,7 +856,7 @@ function TitleFieldTemplate(props: TitleFieldProps) {
856856

857857
render(
858858
<Form schema={schema} validator={validator} templates={{ TitleFieldTemplate }} />,
859-
document.getElementById('app')
859+
document.getElementById('app'),
860860
);
861861
```
862862

@@ -895,7 +895,7 @@ function UnsupportedFieldTemplate(props: UnsupportedFieldProps) {
895895

896896
render(
897897
<Form schema={schema} validator={validator} templates={{ UnsupportedFieldTemplate }} />,
898-
document.getElementById('app')
898+
document.getElementById('app'),
899899
);
900900
```
901901

@@ -952,7 +952,7 @@ function WrapIfAdditionalTemplate(props: WrapIfAdditionalTemplateProps) {
952952

953953
render(
954954
<Form schema={schema} validator={validator} templates={{ WrapIfAdditionalTemplate }} />,
955-
document.getElementById('app')
955+
document.getElementById('app'),
956956
);
957957
```
958958

@@ -1011,7 +1011,7 @@ function AddButton(props: IconButtonProps) {
10111011

10121012
render(
10131013
<Form schema={schema} validator={validator} templates={{ ButtonTemplates: { AddButton } }} />,
1014-
document.getElementById('app')
1014+
document.getElementById('app'),
10151015
);
10161016
```
10171017

@@ -1041,7 +1041,7 @@ function MoveDownButton(props: IconButtonProps) {
10411041

10421042
render(
10431043
<Form schema={schema} validator={validator} templates={{ ButtonTemplates: { MoveDownButton } }} />,
1044-
document.getElementById('app')
1044+
document.getElementById('app'),
10451045
);
10461046
```
10471047

@@ -1071,7 +1071,7 @@ function MoveUpButton(props: IconButtonProps) {
10711071

10721072
render(
10731073
<Form schema={schema} validator={validator} templates={{ ButtonTemplates: { MoveUpButton } }} />,
1074-
document.getElementById('app')
1074+
document.getElementById('app'),
10751075
);
10761076
```
10771077

@@ -1101,7 +1101,7 @@ function RemoveButton(props: IconButtonProps) {
11011101

11021102
render(
11031103
<Form schema={schema} validator={validator} templates={{ ButtonTemplates: { RemoveButton } }} />,
1104-
document.getElementById('app')
1104+
document.getElementById('app'),
11051105
);
11061106
```
11071107

@@ -1137,7 +1137,7 @@ function SubmitButton(props: SubmitButtonProps) {
11371137

11381138
render(
11391139
<Form schema={schema} validator={validator} templates={{ ButtonTemplates: { SubmitButton } }} />,
1140-
document.getElementById('app')
1140+
document.getElementById('app'),
11411141
);
11421142
```
11431143

packages/docs/docs/advanced-customization/custom-widgets-fields.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ The API allows to specify your own custom _widget_ and _field_ components:
77

88
## Customizing the default fields and widgets
99

10-
You can override any default field and widget, including the internal widgets like the `CheckboxWidget` that `BooleanField` renders for boolean values. You can override any field and widget just by providing the customized fields/widgets in the `fields` and `widgets` props:
10+
You can override any default field and widget, including the internal widgets like the `CheckboxWidget` that `BooleanField`
11+
renders for boolean values. You can override any field and widget just by providing the customized fields/widgets in the
12+
`fields` and `widgets` props:
1113

1214
```tsx
1315
import { RJSFSchema, UiSchema, WidgetProps, RegistryWidgetsType } from '@rjsf/utils';
@@ -202,7 +204,7 @@ The following props are passed to custom widget components:
202204
- `onBlur`: The input blur event handler; call it with the widget id and value;
203205
- `onFocus`: The input focus event handler; call it with the widget id and value;
204206
- `options`: A map of options passed as a prop to the component (see [Custom widget options](#custom-widget-options)).
205-
- `options.enumOptions`: For enum fields, this property contains the list of options for the enum as an array of { label, value } objects. If the enum is defined using the oneOf/anyOf syntax, the entire schema object for each option is appended onto the { schema, label, value } object.
207+
- `options.enumOptions`: For enum fields, this property contains the list of options for the enum as an array of \{ label, value } objects. If the enum is defined using the oneOf/anyOf syntax, the entire schema object for each option is appended onto the \{ schema, label, value } object.
206208
- `formContext`: The `formContext` object that you passed to `Form`.
207209
- `rawErrors`: An array of strings listing all generated error messages from encountered errors for this widget.
208210
- `registry`: A [registry](#the-registry-object) object (read next).

packages/docs/docs/api-reference/form-props.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,15 @@ Optional enumerated flag controlling how array minItems are populated, defaultin
8484

8585
The signature and documentation for this property is as follow:
8686

87-
##### computeSkipPopulate <T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>()
87+
##### computeSkipPopulate &lt;T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>()
8888

8989
A function that determines whether to skip populating the array with default values based on the provided validator, schema, and root schema.
9090
If the function returns `true`, the array will not be populated with default values.
9191
If the function returns `false`, the array will be populated with default values according to the `populate` option.
9292

9393
###### Parameters
9494

95-
- validator: ValidatorType<T, S, F> - An implementation of the `ValidatorType` interface that is used to detect valid schema conditions
95+
- validator: ValidatorType&lt;T, S, F> - An implementation of the `ValidatorType` interface that is used to detect valid schema conditions
9696
- schema: S - The schema for which resolving a condition is desired
9797
- [rootSchema]: S - The root schema that will be forwarded to all the APIs
9898

0 commit comments

Comments
 (0)