Remove enumNames #3031

nickgros · 2022-08-21T19:09:08Z

Reasons for making this change

See #3016

Checklist

I'm updating documentation
- I've checked the rendering of the Markdown text I've added
I'm adding or updating code
- I've added and/or updated tests. I've run npm run test:update to update snapshots, if needed.
- I've updated docs if needed
- I've updated the changelog with a description of the PR
I'm adding a new feature
- I've updated the playground with an example use of the feature

heath-freenome

Fix the snapshots so that the tests pass and you are good to go I believe

heath-freenome · 2022-08-22T15:58:59Z

docs/usage/single.md

-#### Alternative JSON-Schema compliant approach
-
-JSON Schema has an alternative approach to enumerations using `anyOf`; react-jsonschema-form supports it as well.
+JSON Schema supports the following approach to enumerations using `oneOf`/`anyOf`; react-jsonschema-form supports it as well.


Also consider adding the oneOf solution mentioned in #532 as an example

packages/core/src/components/fields/BooleanField.tsx

nickgros · 2022-08-23T14:00:49Z

packages/core/src/components/fields/BooleanField.tsx

+    if (
+      schema.enum &&
+      schema.enum.length === 2 &&
+      schema.enum.every((v) => typeof v === "boolean")
+    ) {
+      enumOptions = [
+        { value: schema.enum[0], label: schema.enum[0] ? "Yes" : "No" },
+        { value: schema.enum[1], label: schema.enum[1] ? "Yes" : "No" },
+      ];


@heath-freenome instead of changing the snapshots, I opted to maintain the existing behavior of labeling boolean enums as "Yes"/"No".

Keep this as it is, don't use enumNames

I think we still need to check for user-supplied enumNames, but we can continue to not use enumNames for the [true, false] case

heath-freenome

@nickgros Per your message to Ashwin, I'm adding comments about what I feel aught to be restored and not restored

heath-freenome · 2022-08-24T05:25:52Z

docs/5.x upgrade guide.md

@@ -28,6 +28,10 @@ There are three new packages added in RJSF version 5:

 ### `@rjsf/core` BREAKING CHANGES

+#### Support dropped for non-standard `enumNames` property


@nickgros Change this to an indication of deprecation... maybe it doesn't belong under the breaking change, but still listed as something to be migrated.

heath-freenome · 2022-08-24T05:26:34Z

docs/api-reference/utility-functions.md

+Gets the list of options from the schema. If the schema has an enum list, then those enum values are returned. The labels for the options will be the same as the `value`.
+If the schema has a `oneOf` or `anyOf`, then the value is the list of `const` values from the schema and the label is either the `schema.title`, if it exists, or the value.


@nickgros Revert this, and add a note about the deprecation of enumNames, to be removed in next release

heath-freenome · 2022-08-24T05:28:13Z

docs/usage/single.md

-This library supports a custom [`enumNames`](https://github.com/rjsf-team/react-jsonschema-form/issues/57) property for `enum` fields, which, however is not JSON-Schema compliant (see below for a compliant approach).
-The `enumNames` property allows defining custom labels for each option of an `enum`:
-
-```jsx
-import validator from "@rjsf/validator-ajv6";
-
-const schema = {
-  type: "number",
-  enum: [1, 2, 3],
-  enumNames: ["one", "two", "three"]
-};
-
-render((
-  <Form schema={schema} validator={validator} />
-), document.getElementById("app"));
-```
-


Either restore this, or maybe keep it deleted and instead add a note about enumNames being deprecated only

heath-freenome · 2022-08-24T05:28:35Z

docs/usage/widgets.md

@@ -35,8 +35,33 @@ Here's a list of supported alternative widgets for different JSON Schema data ty
  * `select`: a select box with `true` and `false` as options;
  * by default, a checkbox is used

-> Note: To set the labels for a boolean field, instead of using `true` and `false` you can set `enumNames` in your schema. Note that `enumNames` belongs in your `schema`, not the `uiSchema`, and the order is always `[true, false]`.


Keep this deleted.

heath-freenome · 2022-08-24T05:28:57Z

packages/core/src/components/fields/BooleanField.tsx

+    if (
+      schema.enum &&
+      schema.enum.length === 2 &&
+      schema.enum.every((v) => typeof v === "boolean")
+    ) {
+      enumOptions = [
+        { value: schema.enum[0], label: schema.enum[0] ? "Yes" : "No" },
+        { value: schema.enum[1], label: schema.enum[1] ? "Yes" : "No" },
+      ];


Keep this as it is, don't use enumNames

heath-freenome · 2022-08-24T05:30:27Z

packages/playground/src/samples/alternatives.js

-        enum: ["screen", "multiply", "overlay"],
-        enumNames: ["Screen", "Multiply", "Overlay"],


Do not restore this

heath-freenome · 2022-08-24T05:30:38Z

packages/playground/src/samples/widgets.js

@@ -91,7 +91,20 @@ export default {
        title: "Custom select widget with options",
        type: "string",
        enum: ["foo", "bar"],
-        enumNames: ["Foo", "Bar"],


Do not restore this

heath-freenome · 2022-08-24T05:31:26Z

packages/utils/src/optionsList.ts

-    return schema.enum.map((value, i) => {
-      const label = (schema.enumNames && schema.enumNames[i]) || String(value);


Consider restoring the old hack that I removed since I'd like to not restore the change to the type. Also add a console.warn() about enumNames being deprecated, to be removed in the next major release

heath-freenome · 2022-08-24T05:31:47Z

packages/utils/src/types.ts

- * update this one type. Also, because we are supporting the non-standard `enumNames` prop in the code, define it here.
+ * update this one type.
 */
-export type RJSFSchema = JSONSchema7 & {
-  enumNames?: string[];
-};
+export type RJSFSchema = JSONSchema7;


Keep this change as is... let's not make the type encourage people to use enumNames

heath-freenome · 2022-08-24T05:32:15Z

packages/utils/test/optionsList.test.ts

-    const enumNameSchema = {
-      ...enumSchema,
-      enumNames: ["Option1", "Option2", "Option3"],
-    };
    expect(optionsList(enumSchema)).toEqual(
      enumSchema.enum!.map((opt) => ({ label: opt, value: opt }))
    );
-    expect(optionsList(enumNameSchema)).toEqual(
-      enumNameSchema.enum!.map((opt, index) => {
-        const label = enumNameSchema.enumNames[index] || opt;
-        return { label: label, value: opt };
-      })
-    );


Sigh, I suppose we'll restore this to, checking for console.warn()

Remove enumNames

57e527b

heath-freenome reviewed Aug 22, 2022

View reviewed changes

nickgros added 2 commits August 23, 2022 09:39

Add oneOf example (from code review)

a136fda

Continue to transform boolean enumerations to Yes/No

dadbfa3

nickgros commented Aug 23, 2022

View reviewed changes

packages/core/src/components/fields/BooleanField.tsx Outdated Show resolved Hide resolved

Don't initialize enumOptions

42334df

nickgros commented Aug 23, 2022

View reviewed changes

heath-freenome approved these changes Aug 23, 2022

View reviewed changes

nickgros merged commit eb16fe1 into rjsf-team:rjsf-v5 Aug 23, 2022

heath-freenome reviewed Aug 24, 2022

View reviewed changes

nickgros mentioned this pull request Aug 24, 2022

Revert removing enumnames #3042

Merged

heath-freenome pushed a commit to heath-freenome/react-jsonschema-form that referenced this pull request Aug 27, 2022

Remove enumNames (rjsf-team#3031)

7d98082

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove enumNames #3031

Remove enumNames #3031

nickgros commented Aug 21, 2022

heath-freenome left a comment

heath-freenome Aug 22, 2022

nickgros Aug 23, 2022

nickgros Aug 23, 2022

heath-freenome Aug 24, 2022

nickgros Aug 24, 2022

heath-freenome left a comment

heath-freenome Aug 24, 2022 •

edited

Loading

heath-freenome Aug 24, 2022

heath-freenome Aug 24, 2022

heath-freenome Aug 24, 2022

heath-freenome Aug 24, 2022

heath-freenome Aug 24, 2022

heath-freenome Aug 24, 2022

heath-freenome Aug 24, 2022

heath-freenome Aug 24, 2022 •

edited

Loading

heath-freenome Aug 24, 2022

		@@ -28,6 +28,10 @@ There are three new packages added in RJSF version 5:

		### `@rjsf/core` BREAKING CHANGES

		#### Support dropped for non-standard `enumNames` property

		Gets the list of options from the schema. If the schema has an enum list, then those enum values are returned. The labels for the options will be the same as the `value`.
		If the schema has a `oneOf` or `anyOf`, then the value is the list of `const` values from the schema and the label is either the `schema.title`, if it exists, or the value.

		enum: ["screen", "multiply", "overlay"],
		enumNames: ["Screen", "Multiply", "Overlay"],

		return schema.enum.map((value, i) => {
		const label = (schema.enumNames && schema.enumNames[i]) \|\| String(value);

Remove enumNames #3031

Remove enumNames #3031

Conversation

nickgros commented Aug 21, 2022

Reasons for making this change

Checklist

heath-freenome left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heath-freenome left a comment

Choose a reason for hiding this comment

heath-freenome Aug 24, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heath-freenome Aug 24, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

heath-freenome Aug 24, 2022 •

edited

Loading

heath-freenome Aug 24, 2022 •

edited

Loading