Interface FieldExtensionUiSchema<TFieldReturnValue, TUiOptions>

Type for Field Extension UiSchema

interface FieldExtensionUiSchema<TFieldReturnValue, TUiOptions> {
    "ui:addable"?: boolean;
    "ui:ArrayFieldDescriptionTemplate"?: ComponentType<
        ArrayFieldDescriptionProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:ArrayFieldItemTemplate"?: ComponentType<
        ArrayFieldTemplateItemType<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:ArrayFieldTemplate"?: ComponentType<
        ArrayFieldTemplateProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:ArrayFieldTitleTemplate"?: ComponentType<
        ArrayFieldTitleProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:autocomplete"?: AutoFill;
    "ui:autofocus"?: boolean;
    "ui:BaseInputTemplate"?: ComponentType<
        BaseInputTemplateProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:classNames"?: string;
    "ui:copyable"?: boolean;
    "ui:description"?: string;
    "ui:DescriptionFieldTemplate"?: ComponentType<
        DescriptionFieldProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:disabled"?: boolean;
    "ui:duplicateKeySuffixSeparator"?: string;
    "ui:emptyValue"?: any;
    "ui:enumDisabled"?: (string | number | boolean)[];
    "ui:enumNames"?: string[];
    "ui:ErrorListTemplate"?: ComponentType<
        ErrorListProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:field"?: string | Field<TFieldReturnValue, RJSFSchema, any>;
    "ui:FieldErrorTemplate"?: ComponentType<
        FieldErrorProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:FieldHelpTemplate"?: ComponentType<
        FieldHelpProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:fieldReplacesAnyOrOneOf"?: boolean;
    "ui:FieldTemplate"?: ComponentType<
        FieldTemplateProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:filePreview"?: boolean;
    "ui:globalOptions"?: GlobalUISchemaOptions;
    "ui:help"?: string;
    "ui:hideError"?: boolean;
    "ui:inline"?: boolean;
    "ui:inputType"?: string;
    "ui:label"?: boolean;
    "ui:ObjectFieldTemplate"?: ComponentType<
        ObjectFieldTemplateProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:options"?: TUiOptions & Partial<
        Omit<
            TemplatesType<TFieldReturnValue, RJSFSchema, any>,
            "ButtonTemplates",
        >,
    > & GlobalUISchemaOptions & {
        autocomplete?: AutoFill;
        autofocus?: boolean;
        classNames?: string;
        description?: string;
        disabled?: boolean;
        emptyValue?: any;
        enumDisabled?: (string | number | boolean)[];
        enumNames?: string[];
        filePreview?: boolean;
        help?: string;
        hideError?: boolean;
        inline?: boolean;
        inputType?: string;
        order?: string[];
        placeholder?: string;
        readonly?: boolean;
        rows?: number;
        style?: StyleHTMLAttributes<any>;
        submitButtonOptions?: UISchemaSubmitButtonOptions;
        title?: string;
        widget?: string | Widget<TFieldReturnValue, RJSFSchema, any>;
    } & {
        [key: string]: | string
        | number
        | boolean
        | object
        | any[]
        | null
        | undefined;
    };
    "ui:order"?: string[];
    "ui:orderable"?: boolean;
    "ui:placeholder"?: string;
    "ui:readonly"?: boolean;
    "ui:removable"?: boolean;
    "ui:rootFieldId"?: string;
    "ui:rows"?: number;
    "ui:style"?: StyleHTMLAttributes<any>;
    "ui:submitButtonOptions"?: UISchemaSubmitButtonOptions;
    "ui:title"?: string;
    "ui:TitleFieldTemplate"?: ComponentType<
        TitleFieldProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:UnsupportedFieldTemplate"?: ComponentType<
        UnsupportedFieldProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    "ui:widget"?: string | Widget<TFieldReturnValue, RJSFSchema, any>;
    "ui:WrapIfAdditionalTemplate"?: ComponentType<
        WrapIfAdditionalTemplateProps<TFieldReturnValue, RJSFSchema, any>,
    >;
    [name: string]: any;
}

Type Parameters

TFieldReturnValue
TUiOptions

Hierarchy

UiSchema<TFieldReturnValue>
- FieldExtensionUiSchema

Indexable

[name: string]: any

Properties

`Optional`ui:addable

"ui:addable"?: boolean

`Optional`ui:ArrayFieldDescriptionTemplate

"ui:ArrayFieldDescriptionTemplate"?: ComponentType<
ArrayFieldDescriptionProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:ArrayFieldItemTemplate

"ui:ArrayFieldItemTemplate"?: ComponentType<
ArrayFieldTemplateItemType<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:ArrayFieldTemplate

"ui:ArrayFieldTemplate"?: ComponentType<
ArrayFieldTemplateProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:ArrayFieldTitleTemplate

"ui:ArrayFieldTitleTemplate"?: ComponentType<
ArrayFieldTitleProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:autocomplete

"ui:autocomplete"?: AutoFill

`Optional`ui:autofocus

"ui:autofocus"?: boolean

`Optional`ui:BaseInputTemplate

"ui:BaseInputTemplate"?: ComponentType<
BaseInputTemplateProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:classNames

"ui:classNames"?: string

`Optional`ui:copyable

"ui:copyable"?: boolean

`Optional`ui:description

"ui:description"?: string

`Optional`ui:DescriptionFieldTemplate

"ui:DescriptionFieldTemplate"?: ComponentType<
DescriptionFieldProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:disabled

"ui:disabled"?: boolean

`Optional`ui:duplicateKeySuffixSeparator

"ui:duplicateKeySuffixSeparator"?: string

`Optional`ui:emptyValue

"ui:emptyValue"?: any

`Optional`ui:enumDisabled

"ui:enumDisabled"?: (string | number | boolean)[]

`Optional`ui:enumNames

"ui:enumNames"?: string[]

`Optional`ui:ErrorListTemplate

"ui:ErrorListTemplate"?: ComponentType<
ErrorListProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:field

"ui:field"?: string | Field<TFieldReturnValue, RJSFSchema, any>

Allows RJSF to override the default field implementation by specifying either the name of a field that is used to look up an implementation from the fields list or an actual one-off Field component implementation itself

`Optional`ui:FieldErrorTemplate

"ui:FieldErrorTemplate"?: ComponentType<
FieldErrorProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:FieldHelpTemplate

"ui:FieldHelpTemplate"?: ComponentType<
FieldHelpProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:fieldReplacesAnyOrOneOf

"ui:fieldReplacesAnyOrOneOf"?: boolean

By default, any field that is rendered for an anyOf/oneOf schema will be wrapped inside the AnyOfField or OneOfField component. This default behavior may be undesirable if your custom field already handles behavior related to choosing one or more subschemas contained in the anyOf/oneOf schema. By providing a true value for this flag in association with a custom ui:field, the wrapped components will be omitted, so just one instance of the custom field will be rendered. If the flag is omitted or set to false, your custom field will be wrapped by AnyOfField/OneOfField.

`Optional`ui:FieldTemplate

"ui:FieldTemplate"?: ComponentType<
FieldTemplateProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:filePreview

"ui:filePreview"?: boolean

`Optional`ui:globalOptions

"ui:globalOptions"?: GlobalUISchemaOptions

The set of Globally relevant UI Schema options that are read from the root-level UiSchema and stored in the Registry for use everywhere.

`Optional`ui:help

"ui:help"?: string

`Optional`ui:hideError

"ui:hideError"?: boolean

`Optional`ui:inline

"ui:inline"?: boolean

`Optional`ui:inputType

"ui:inputType"?: string

`Optional`ui:label

"ui:label"?: boolean

`Optional`ui:ObjectFieldTemplate

"ui:ObjectFieldTemplate"?: ComponentType<
ObjectFieldTemplateProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:options

"ui:options"?: TUiOptions & Partial<
    Omit<
        TemplatesType<TFieldReturnValue, RJSFSchema, any>,
        "ButtonTemplates",
    >,
> & GlobalUISchemaOptions & {
    autocomplete?: AutoFill;
    autofocus?: boolean;
    classNames?: string;
    description?: string;
    disabled?: boolean;
    emptyValue?: any;
    enumDisabled?: (string | number | boolean)[];
    enumNames?: string[];
    filePreview?: boolean;
    help?: string;
    hideError?: boolean;
    inline?: boolean;
    inputType?: string;
    order?: string[];
    placeholder?: string;
    readonly?: boolean;
    rows?: number;
    style?: StyleHTMLAttributes<any>;
    submitButtonOptions?: UISchemaSubmitButtonOptions;
    title?: string;
    widget?: string | Widget<TFieldReturnValue, RJSFSchema, any>;
} & {
    [key: string]: | string
    | number
    | boolean
    | object
    | any[]
    | null
    | undefined;
}

An object that contains all the potential UI options in a single object

Type Declaration

Optionalautocomplete?: AutoFill
Use to mark the field as supporting auto complete on a text input or textarea input
Optionalautofocus?: boolean
Flag, if set to true, will mark the field as automatically focused on a text input or textarea input
OptionalclassNames?: string
Any classnames that the user wants to be applied to a field in the ui
Optionaldescription?: string
We know that for description, it will be a string, if it is provided
Optionaldisabled?: boolean
Flag, if set to true, will mark all child widgets from a given field as disabled
OptionalemptyValue?: any
The default value to use when an input for a field is empty
OptionalenumDisabled?: (string | number | boolean)[]
Will disable any of the enum options specified in the array (by value)
OptionalenumNames?: string[]
Allows a user to provide a list of labels for enum values in the schema
OptionalfilePreview?: boolean
Flag, if set to true, will cause the FileWidget to show a preview (with download for non-image files)
Optionalhelp?: string
Used to add text next to a field to guide the end user in filling it in
OptionalhideError?: boolean
Flag, if set to true, will hide the default error display for the given field AND all of its child fields in the hierarchy
Optionalinline?: boolean
Flag, if set to true, will mark a list of checkboxes as displayed all on one line instead of one per row
OptionalinputType?: string
Used to change the input type (for example, tel or email) for an
Optionalorder?: string[]
This property allows you to reorder the properties that are shown for a particular object
Optionalplaceholder?: string
We know that for placeholder, it will be a string, if it is provided
Optionalreadonly?: boolean
Flag, if set to true, will mark all child widgets from a given field as read-only
Optionalrows?: number
Provides a means to set the initial height of a textarea widget
Optionalstyle?: StyleHTMLAttributes<any>
Any custom style that the user wants to apply to a field in the ui, applied on the same element as classNames
OptionalsubmitButtonOptions?: UISchemaSubmitButtonOptions
If submitButtonOptions is provided it should match the UISchemaSubmitButtonOptions type
Optionaltitle?: string
We know that for title, it will be a string, if it is provided
Optionalwidget?: string | Widget<TFieldReturnValue, RJSFSchema, any>
Allows RJSF to override the default widget implementation by specifying either the name of a widget that is used to look up an implementation from the widgets list or an actual one-off widget implementation itself

[key: string]: string | number | boolean | object | any[] | null | undefined
Anything else will be one of these types

`Optional`ui:order

"ui:order"?: string[]

`Optional`ui:orderable

"ui:orderable"?: boolean

`Optional`ui:placeholder

"ui:placeholder"?: string

`Optional`ui:readonly

"ui:readonly"?: boolean

`Optional`ui:removable

"ui:removable"?: boolean

`Optional`ui:rootFieldId

"ui:rootFieldId"?: string

Allows the form to generate a unique prefix for the Form's root prefix

`Optional`ui:rows

"ui:rows"?: number

`Optional`ui:style

"ui:style"?: StyleHTMLAttributes<any>

`Optional`ui:submitButtonOptions

"ui:submitButtonOptions"?: UISchemaSubmitButtonOptions

`Optional`ui:title

"ui:title"?: string

`Optional`ui:TitleFieldTemplate

"ui:TitleFieldTemplate"?: ComponentType<
TitleFieldProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:UnsupportedFieldTemplate

"ui:UnsupportedFieldTemplate"?: ComponentType<
UnsupportedFieldProps<TFieldReturnValue, RJSFSchema, any>,
>

`Optional`ui:widget

"ui:widget"?: string | Widget<TFieldReturnValue, RJSFSchema, any>

`Optional`ui:WrapIfAdditionalTemplate

"ui:WrapIfAdditionalTemplate"?: ComponentType<
WrapIfAdditionalTemplateProps<TFieldReturnValue, RJSFSchema, any>,
>

Interface FieldExtensionUiSchema<TFieldReturnValue, TUiOptions>

Type Parameters

Hierarchy

Indexable

Index

Properties

Properties

Optionalui:addable

Optionalui:ArrayFieldDescriptionTemplate

Optionalui:ArrayFieldItemTemplate

Optionalui:ArrayFieldTemplate

Optionalui:ArrayFieldTitleTemplate

Optionalui:autocomplete

Optionalui:autofocus

Optionalui:BaseInputTemplate

Optionalui:classNames

Optionalui:copyable

Optionalui:description

Optionalui:DescriptionFieldTemplate

Optionalui:disabled

Optionalui:duplicateKeySuffixSeparator

Optionalui:emptyValue

Optionalui:enumDisabled

Optionalui:enumNames

Optionalui:ErrorListTemplate

Optionalui:field

Optionalui:FieldErrorTemplate

Optionalui:FieldHelpTemplate

Optionalui:fieldReplacesAnyOrOneOf

Optionalui:FieldTemplate

Optionalui:filePreview

Optionalui:globalOptions

Optionalui:help

Optionalui:hideError

Optionalui:inline

Optionalui:inputType

Optionalui:label

Optionalui:ObjectFieldTemplate

Optionalui:options

Type Declaration

Optionalautocomplete?: AutoFill

Optionalautofocus?: boolean

OptionalclassNames?: string

Optionaldescription?: string

Optionaldisabled?: boolean

OptionalemptyValue?: any

OptionalenumDisabled?: (string | number | boolean)[]

OptionalenumNames?: string[]

OptionalfilePreview?: boolean

Optionalhelp?: string

OptionalhideError?: boolean

Optionalinline?: boolean

OptionalinputType?: string

Optionalorder?: string[]

Optionalplaceholder?: string

Optionalreadonly?: boolean

Optionalrows?: number

Optionalstyle?: StyleHTMLAttributes<any>

OptionalsubmitButtonOptions?: UISchemaSubmitButtonOptions

Optionaltitle?: string

Optionalwidget?: string | Widget<TFieldReturnValue, RJSFSchema, any>

[key: string]: string | number | boolean | object | any[] | null | undefined

Optionalui:order

Optionalui:orderable

Optionalui:placeholder

Optionalui:readonly

Optionalui:removable

Optionalui:rootFieldId

Optionalui:rows

Optionalui:style

Optionalui:submitButtonOptions

Optionalui:title

Optionalui:TitleFieldTemplate

Optionalui:UnsupportedFieldTemplate

Optionalui:widget

Optionalui:WrapIfAdditionalTemplate

Settings

On This Page

`Optional`ui:addable

`Optional`ui:ArrayFieldDescriptionTemplate

`Optional`ui:ArrayFieldItemTemplate

`Optional`ui:ArrayFieldTemplate

`Optional`ui:ArrayFieldTitleTemplate

`Optional`ui:autocomplete

`Optional`ui:autofocus

`Optional`ui:BaseInputTemplate

`Optional`ui:classNames

`Optional`ui:copyable

`Optional`ui:description

`Optional`ui:DescriptionFieldTemplate

`Optional`ui:disabled

`Optional`ui:duplicateKeySuffixSeparator

`Optional`ui:emptyValue

`Optional`ui:enumDisabled

`Optional`ui:enumNames

`Optional`ui:ErrorListTemplate

`Optional`ui:field

`Optional`ui:FieldErrorTemplate

`Optional`ui:FieldHelpTemplate

`Optional`ui:fieldReplacesAnyOrOneOf

`Optional`ui:FieldTemplate

`Optional`ui:filePreview

`Optional`ui:globalOptions

`Optional`ui:help

`Optional`ui:hideError

`Optional`ui:inline

`Optional`ui:inputType

`Optional`ui:label

`Optional`ui:ObjectFieldTemplate

`Optional`ui:options

`Optional`autocomplete?: AutoFill

`Optional`autofocus?: boolean

`Optional`classNames?: string

`Optional`description?: string

`Optional`disabled?: boolean

`Optional`emptyValue?: any

`Optional`enumDisabled?: (string | number | boolean)[]

`Optional`enumNames?: string[]

`Optional`filePreview?: boolean

`Optional`help?: string

`Optional`hideError?: boolean

`Optional`inline?: boolean

`Optional`inputType?: string

`Optional`order?: string[]

`Optional`placeholder?: string

`Optional`readonly?: boolean

`Optional`rows?: number

`Optional`style?: StyleHTMLAttributes<any>

`Optional`submitButtonOptions?: UISchemaSubmitButtonOptions

`Optional`title?: string

`Optional`widget?: string | Widget<TFieldReturnValue, RJSFSchema, any>

`Optional`ui:order

`Optional`ui:orderable

`Optional`ui:placeholder

`Optional`ui:readonly

`Optional`ui:removable

`Optional`ui:rootFieldId

`Optional`ui:rows

`Optional`ui:style

`Optional`ui:submitButtonOptions

`Optional`ui:title

`Optional`ui:TitleFieldTemplate

`Optional`ui:UnsupportedFieldTemplate

`Optional`ui:widget

`Optional`ui:WrapIfAdditionalTemplate