@rjsf/utils
Version:
Utility functions for @rjsf/core
40 lines • 2.04 kB
JavaScript
import { UI_FIELD_KEY, UI_WIDGET_KEY } from '../constants.js';
import getSchemaType from '../getSchemaType.js';
import getUiOptions from '../getUiOptions.js';
import isCustomWidget from '../isCustomWidget.js';
import isFilesArray from './isFilesArray.js';
import isMultiSelect from './isMultiSelect.js';
/** Determines whether the combination of `schema` and `uiSchema` properties indicates that the label for the `schema`
* should be displayed in a UI.
*
* @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
* @param schema - The schema for which the display label flag is desired
* @param [uiSchema={}] - The UI schema from which to derive potentially displayable information
* @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
* @param [globalOptions={}] - The optional Global UI Schema from which to get any fallback `xxx` options
* @param [experimental_customMergeAllOf] - Optional function that allows for custom merging of `allOf` schemas
* @returns - True if the label should be displayed or false if it should not
*/
export default function getDisplayLabel(validator, schema, uiSchema = {}, rootSchema, globalOptions, experimental_customMergeAllOf) {
const uiOptions = getUiOptions(uiSchema, globalOptions);
const { label = true } = uiOptions;
let displayLabel = !!label;
const schemaType = getSchemaType(schema);
if (schemaType === 'array') {
displayLabel =
isMultiSelect(validator, schema, rootSchema, experimental_customMergeAllOf) ||
isFilesArray(validator, schema, uiSchema, rootSchema, experimental_customMergeAllOf) ||
isCustomWidget(uiSchema);
}
if (schemaType === 'object') {
displayLabel = false;
}
if (schemaType === 'boolean' && !uiSchema[UI_WIDGET_KEY]) {
displayLabel = false;
}
if (uiSchema[UI_FIELD_KEY]) {
displayLabel = false;
}
return displayLabel;
}
//# sourceMappingURL=getDisplayLabel.js.map