Skip to content

Remove JSON Schema enumNames example #4646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 30, 2025
Merged

Remove JSON Schema enumNames example #4646

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
345a303
Remove JSON Schema enumNames example
nickgros May 30, 2025
cc8ff30
improve clarity
nickgros May 30, 2025
4470330
Merge branch 'main' into remove-stale-doc
nickgros May 30, 2025
99c89fe
improve clarity once more
nickgros May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 1 addition & 15 deletions packages/docs/docs/json-schema/single.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,21 +107,7 @@ const schema: RJSFSchema = {
render(<Form schema={schema} validator={validator} />, document.getElementById('app'));
```

In your JSON Schema, you may also specify `enumNames`, a non-standard field which RJSF can use to label an enumeration. **This behavior is deprecated and will be removed in a future major release of RJSF. Use the "ui:enumNames" property in the uiSchema instead.**

```tsx
import { RJSFSchema } from '@rjsf/utils';
import validator from '@rjsf/validator-ajv8';

const schema: RJSFSchema = {
type: 'number',
enum: [1, 2, 3],
enumNames: ['one', 'two', 'three'],
};
render(<Form schema={schema} validator={validator} />, document.getElementById('app'));
```

Same example using the `uiSchema`'s `ui:enumNames` instead.
In your `uiSchema`, you may also specify `ui:enumNames`, which RJSF can use to label an enumeration.

```tsx
import { RJSFSchema, UiSchema } from '@rjsf/utils';
Expand Down