@rjsf/utils
Version:
Utility functions for @rjsf/core
59 lines • 3.01 kB
JavaScript
import toConstant from './toConstant.js';
import getUiOptions from './getUiOptions.js';
/** 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 extracted from the non-standard, RJSF-deprecated `enumNames` if it exists, otherwise
* the label 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` or the value. If a `uiSchema` is provided
* and it has the `ui:enumNames` matched with `enum` or it has an associated `oneOf` or `anyOf` with a list of objects
* containing `ui:title` then the UI schema values will replace the values from the schema.
*
* @param schema - The schema from which to extract the options list
* @param [uiSchema] - The optional uiSchema from which to get alternate labels for the options
* @returns - The list of options from the schema
*/
export default function optionsList(schema, uiSchema) {
// TODO flip generics to move T first in v6
const schemaWithEnumNames = schema;
if (schema.enum) {
let enumNames;
if (uiSchema) {
const { enumNames: uiEnumNames } = getUiOptions(uiSchema);
enumNames = uiEnumNames;
}
if (!enumNames && schemaWithEnumNames.enumNames) {
// enumNames was deprecated in v5 and is intentionally omitted from the RJSFSchema type.
// Cast the type to include enumNames so the feature still works.
if (process.env.NODE_ENV !== 'production') {
console.warn('The "enumNames" property in the schema is deprecated and will be removed in a future major release. Use the "ui:enumNames" property in the uiSchema instead.');
}
enumNames = schemaWithEnumNames.enumNames;
}
return schema.enum.map((value, i) => {
const label = (enumNames === null || enumNames === void 0 ? void 0 : enumNames[i]) || String(value);
return { label, value };
});
}
let altSchemas = undefined;
let altUiSchemas = undefined;
if (schema.anyOf) {
altSchemas = schema.anyOf;
altUiSchemas = uiSchema === null || uiSchema === void 0 ? void 0 : uiSchema.anyOf;
}
else if (schema.oneOf) {
altSchemas = schema.oneOf;
altUiSchemas = uiSchema === null || uiSchema === void 0 ? void 0 : uiSchema.oneOf;
}
return (altSchemas &&
altSchemas.map((aSchemaDef, index) => {
const { title } = getUiOptions(altUiSchemas === null || altUiSchemas === void 0 ? void 0 : altUiSchemas[index]);
const aSchema = aSchemaDef;
const value = toConstant(aSchema);
const label = title || aSchema.title || String(value);
return {
schema: aSchema,
label,
value,
};
}));
}
//# sourceMappingURL=optionsList.js.map