# This is the documentation for the FormEngine packages.

> It contains detailed manuals, components, and utilities for creating user interfaces.


## documentation

FormEngine is a comprehensive suite of products that enables you to create, manage, and deploy online forms with unprecedented ease and

- [Introduction](https://formengine.io/documentation/documentation/): FormEngine is a comprehensive suite of products that enables you to create, manage, and deploy online forms with unprecedented ease and

### search

- [Search the documentation](https://formengine.io/documentation/documentation/search)

### adding-wasm-component

Guide to connecting the WASM component

- [Adding WASM component](https://formengine.io/documentation/documentation/adding-wasm-component): Guide to connecting the WASM component

### api-reference

Packages

- [API reference](https://formengine.io/documentation/documentation/api-reference/): Packages
- [@react-form-builder/components-fast-qr](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/): Interfaces
- [Interface: FastQrProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/interfaces/FastQrProps): The Fast QR component properties.
- [Variable: fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponent): const fastQrComponent: Definer\ = fastQr
- [Variable: fastQrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponentsDescriptions): const fastQrComponentsDescriptions: Record\
- [Variable: fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrEnUsComponentsDescriptions): fastQrEnUsComponentsDescriptions: object
- [Variable: fastQrModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrModel): const fastQrModel: Model\
- [@react-form-builder/components-google-map](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/): Interfaces
- [Function: toAddress()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/functions/toAddress): toAddress(components): Address
- [Interface: GoogleMapProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/interfaces/GoogleMapProps): Props for the GoogleMap component.
- [Type Alias: Address](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address): Address = object
- [Type Alias: MapMarker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker): MapMarker = object
- [Variable: googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponent): const googleMapComponent: Definer\ = googleMap
- [Variable: googleMapComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponentsDescriptions): const googleMapComponentsDescriptions: Record\
- [Variable: googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapEnUsComponentsDescriptions): googleMapEnUsComponentsDescriptions: object
- [Variable: googleMapModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapModel): const googleMapModel: Model\
- [@react-form-builder/components-material-ui](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/): Interfaces
- [Function: MuiErrorWrapper()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/functions/MuiErrorWrapper): MuiErrorWrapper(props): Element
- [Interface: BreadcrumbsItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem): Settings for a single breadcrumb item.
- [Interface: MuiBoxProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBoxProps): The MuiBox component properties.
- [Interface: MuiBreadcrumbsItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBreadcrumbsItemProps): Props for a single breadcrumb item component.
- [Interface: MuiBreadcrumbsProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBreadcrumbsProps): Props for the MuiBreadcrumbs component.
- [Interface: MuiCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiCardProps): Props for the MuiCard component.
- [Interface: MuiCheckboxProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiCheckboxProps): Props for the MuiCheckbox component.
- [Interface: MuiContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiContainerProps): The MuiContainer component properties.
- [Interface: MuiDialogProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiDialogProps): Props for the MuiDialog component.
- [Interface: MuiFormControlLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiFormControlLabelProps): Props for the MuiFormControlLabel component.
- [Interface: MuiFormControlProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiFormControlProps): Props for the Material-UI FormControl component.
- [Interface: MuiListItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiListItemProps): The MuiListItem component properties.
- [Interface: MuiListProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiListProps): The MuiList component properties.
- [Interface: MuiRadioItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiRadioItemProps): Props for the MuiRadioItem component.
- [Interface: MuiSelectProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiSelectProps): The MuiSelect component properties.
- [Interface: MuiStackProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiStackProps): The MuiStack component properties.
- [Interface: MuiSwitchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiSwitchProps): Props for the MuiSwitch component.
- [Type Alias: MuiTextFieldProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/type-aliases/MuiTextFieldProps): MuiTextFieldProps = ComponentProps\ & object
- [Variable: builderView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/builderView): const builderView: BuilderView
- [Variable: components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/components): const components: BuilderComponent[]
- [Variable: materialUiComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/materialUiComponentsDescriptions): const materialUiComponentsDescriptions: Record\
- [Variable: models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/models): const models: Model\[]
- [Variable: muiArEgComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiArEgComponentsDescriptions): muiArEgComponentsDescriptions: object
- [Variable: muiBox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiBox): const muiBox: Definer\ & RefAttributes\\>
- [Variable: muiBreadcrumbs](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiBreadcrumbs): const muiBreadcrumbs: Definer\
- [Variable: muiButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiButton): const muiButton: Definer\
- [Variable: muiButtonGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiButtonGroup): const muiButtonGroup: Definer\\>\>
- [Variable: muiCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiCard): const muiCard: Definer\
- [Variable: muiCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiCheckbox): const muiCheckbox: Definer\
- [Variable: muiCircularProgress](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiCircularProgress): const muiCircularProgress: Definer\
- [Variable: muiComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiComponents): const muiComponents: Definer\[]
- [Variable: muiContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiContainer): const muiContainer: Definer\ & RefAttributes\\>
- [Variable: muiDeDeComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDeDeComponentsDescriptions): muiDeDeComponentsDescriptions: object
- [Variable: muiDialog](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialog): const muiDialog: Definer\
- [Variable: muiDialogActions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogActions): const muiDialogActions: Definer\
- [Variable: muiDialogContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogContent): const muiDialogContent: Definer\
- [Variable: muiDialogContentText](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogContentText): const muiDialogContentText: Definer\\>\>
- [Variable: muiDialogLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogLayout): const muiDialogLayout: Definer\
- [Variable: muiDialogTitle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogTitle): const muiDialogTitle: Definer\\>\>
- [Variable: muiEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiEnUsComponentsDescriptions): muiEnUsComponentsDescriptions: object
- [Variable: muiErrorWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiErrorWrapper): const muiErrorWrapper: Definer\
- [Variable: muiEsEsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiEsEsComponentsDescriptions): muiEsEsComponentsDescriptions: object
- [Variable: muiFaIrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFaIrComponentsDescriptions): muiFaIrComponentsDescriptions: object
- [Variable: muiFormControlLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFormControlLabel): const muiFormControlLabel: Definer\
- [Variable: muiFormLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFormLabel): const muiFormLabel: Definer\\>\>
- [Variable: muiFrFrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFrFrComponentsDescriptions): muiFrFrComponentsDescriptions: object
- [Variable: muiHiInComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiHiInComponentsDescriptions): muiHiInComponentsDescriptions: object
- [Variable: muiItItComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiItItComponentsDescriptions): muiItItComponentsDescriptions: object
- [Variable: muiJaJpComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiJaJpComponentsDescriptions): muiJaJpComponentsDescriptions: object
- [Variable: muiKoKrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiKoKrComponentsDescriptions): muiKoKrComponentsDescriptions: object
- [Variable: muiLinearProgress](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiLinearProgress): const muiLinearProgress: Definer\
- [Variable: muiLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiLink): const muiLink: Definer\
- [Variable: muiList](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiList): const muiList: Definer\ & RefAttributes\\>
- [Variable: muiListItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiListItem): const muiListItem: Definer\ & RefAttributes\\>
- [Variable: muiRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiRadioGroup): const muiRadioGroup: Definer\
- [Variable: muiRadioItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiRadioItem): const muiRadioItem: Definer\
- [Variable: muiSelect](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiSelect): const muiSelect: Definer\
- [Variable: muiSrRsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiSrRsComponentsDescriptions): muiSrRsComponentsDescriptions: object
- [Variable: muiStack](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiStack): const muiStack: Definer\ & RefAttributes\\>
- [Variable: muiSwitch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiSwitch): const muiSwitch: Definer\
- [Variable: muiTextField](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiTextField): const muiTextField: Definer\
- [Variable: muiTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiTooltip): const muiTooltip: Definer\
- [Variable: muiTypography](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiTypography): const muiTypography: Definer\\>\>
- [Variable: muiUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiUploader): const muiUploader: Definer\
- [Variable: MuiViewerWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/MuiViewerWrapper): const MuiViewerWrapper: FormViewerWrapper
- [Variable: muiZhCnComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiZhCnComponentsDescriptions): muiZhCnComponentsDescriptions: object
- [Variable: view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/view): const view: View
- [@react-form-builder/components-rich-text](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/): Interfaces
- [Interface: RichTextEditorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/interfaces/RichTextEditorProps): The Rich text editor component properties.
- [Variable: richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextComponent): const richTextComponent: Definer\ = richTextEditor
- [Variable: richTextEditorComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorComponentsDescriptions): const richTextEditorComponentsDescriptions: Record\
- [Variable: richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorEnUsComponentsDescriptions): richTextEditorEnUsComponentsDescriptions: object
- [Variable: richTextModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextModel): const richTextModel: Model\
- [@react-form-builder/components-rsuite-table](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/): Variables
- [Variable: rSuiteTableComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/rSuiteTableComponents): const rSuiteTableComponents: Definer\[] = []
- [Variable: rSuiteTableComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/rSuiteTableComponentsDescriptions): const rSuiteTableComponentsDescriptions: Record\
- [Variable: rSuiteTableEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/rSuiteTableEnUsComponentsDescriptions): rSuiteTableEnUsComponentsDescriptions: object
- [Variable: tableModels](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/tableModels): const tableModels: Model\[]
- [@react-form-builder/components-rsuite](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/): Interfaces
- [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/formEngineRsuiteCssLoader): formEngineRsuiteCssLoader(): Promise\
- [Function: ltrCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/ltrCssLoader): ltrCssLoader(): Promise\
- [Function: RsLocalizationWrapper()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/RsLocalizationWrapper): RsLocalizationWrapper(props): Element
- [Function: rtlCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/rtlCssLoader): rtlCssLoader(): Promise\
- [Interface: RsAutoCompleteProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsAutoCompleteProps): The properties of the RsAutoComplete component.
- [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbItemProps): Props for a single breadcrumb item.
- [Interface: RsBreadcrumbProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbProps): Props for the RsBreadcrumb component.
- [Interface: RsCalendarProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCalendarProps): Props for the RsCalendar component.
- [Interface: RsCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCardProps): Props for the RsCard component.
- [Interface: RsContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsContainerProps): Props for the RsContainer component.
- [Interface: RsDatePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDatePickerProps): Props for the RsDatePicker component.
- [Interface: RsDropdownProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDropdownProps): Props for the RsDropdown component.
- [Interface: RsErrorMessageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps): The properties of RsErrorMessage component.
- [Interface: RsHeaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsHeaderProps): Props for the RsHeader component.
- [Interface: RsImageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsImageProps): Props for the RsImage component.
- [Interface: RsInputProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsInputProps): Props for the RsInput component.
- [Interface: RsLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLabelProps): Props for the RsLabel component.
- [Interface: RsLinkProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLinkProps): Props for the RsLink component.
- [Interface: RsMenuProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsMenuProps): Props for the RsMenu component.
- [Interface: RsModalLayoutProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalLayoutProps): Props for the RsModalLayout component.
- [Interface: RsModalProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalProps): Props for the RsModal component.
- [Interface: RsNumberFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsNumberFormatProps): Props for the RsNumberFormat component.
- [Interface: RsPatternFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsPatternFormatProps): Props for the RsPatternFormat component.
- [Interface: RsRadioGroupProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsRadioGroupProps): Props for the RsRadioGroup component.
- [Interface: RsSearchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsSearchProps): Props for the RsSearch component.
- [Interface: RsStaticContentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsStaticContentProps): Props for the RsStaticContent component.
- [Interface: RsTabProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTabProps): Props for the RsTab component.
- [Interface: RsTagPickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTagPickerProps): Props for the RsTagPicker component.
- [Interface: RsTextAreaProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTextAreaProps): Props for the RsTextArea component.
- [Interface: RsTimePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTimePickerProps): Props for the RsTimePicker component.
- [Interface: RsTooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps): The properties of RsTooltip component.
- [Interface: RsUploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsUploaderProps): Props for the RsUploader component.
- [Interface: RsWizardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardProps): Props for the RsWizard component.
- [Interface: RsWizardStepProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardStepProps): Props for the RsWizardStep component.
- [Type Alias: LoadCallback()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadCallback): LoadCallback = (newData) => void
- [Type Alias: LoadDataHandler()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadDataHandler): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => void
- [Type Alias: MenuItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/MenuItem): MenuItem = object
- [Type Alias: RsTabItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/RsTabItem): RsTabItem = object
- [Variable: builderViewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/builderViewWithCss): const builderViewWithCss: BuilderView
- [Variable: components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/components): const components: BuilderComponent[]
- [Variable: models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/models): const models: Model\[]
- [Variable: rsAutoComplete](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsAutoComplete): const rsAutoComplete: Definer\
- [Variable: rsBreadcrumb](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsBreadcrumb): const rsBreadcrumb: Definer\
- [Variable: rsButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsButton): const rsButton: Definer\
- [Variable: rsCalendar](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCalendar): const rsCalendar: Definer\
- [Variable: rsCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCard): const rsCard: Definer\
- [Variable: rsCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCheckbox): const rsCheckbox: Definer\\>
- [Variable: rsContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsContainer): const rsContainer: Definer\\>
- [Variable: rsDatePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDatePicker): const rsDatePicker: Definer\
- [Variable: rsDivider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDivider): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\>
- [Variable: rsDropdown](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDropdown): const rsDropdown: Definer\
- [Variable: rsErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsErrorMessage): const rsErrorMessage: Definer\
- [Variable: rsHeader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsHeader): const rsHeader: Definer\
- [Variable: rsImage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsImage): const rsImage: Definer\
- [Variable: rsInput](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsInput): const rsInput: Definer\
- [Variable: rsLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLabel): const rsLabel: Definer\
- [Variable: rsLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLink): const rsLink: Definer\
- [Variable: rsMenu](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMenu): const rsMenu: Definer\
- [Variable: rsMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMessage): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\>
- [Variable: rsModal](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModal): const rsModal: Definer\
- [Variable: rsModalLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModalLayout): const rsModalLayout: Definer\
- [Variable: rsNumberFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsNumberFormat): const rsNumberFormat: Definer\
- [Variable: rsPatternFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPatternFormat): const rsPatternFormat: Definer\
- [Variable: rsPlaceholderGraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGraph): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\>
- [Variable: rsPlaceholderGrid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGrid): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\>
- [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderParagraph): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\>
- [Variable: rsProgressCircle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressCircle): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\>
- [Variable: rsProgressLine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressLine): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\>
- [Variable: rsRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsRadioGroup): const rsRadioGroup: Definer\
- [Variable: rsSearch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsSearch): const rsSearch: Definer\
- [Variable: rsStaticContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsStaticContent): const rsStaticContent: Definer\
- [Variable: rsTab](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTab): const rsTab: Definer\
- [Variable: rsTagPicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTagPicker): const rsTagPicker: Definer\
- [Variable: rsTextArea](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTextArea): const rsTextArea: Definer\
- [Variable: rsTimePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTimePicker): const rsTimePicker: Definer\
- [Variable: rsToggle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsToggle): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\>
- [Variable: rsTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTooltip): const rsTooltip: Definer\
- [Variable: rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponents): const rSuiteComponents: Definer\[] = []
- [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponentsDescriptions): const rSuiteComponentsDescriptions: Record\
- [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteEnUsComponentsDescriptions): rSuiteEnUsComponentsDescriptions: object
- [Variable: rsUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsUploader): const rsUploader: Definer\
- [Variable: rsWizard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizard): const rsWizard: Definer\
- [Variable: rsWizardStep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizardStep): const rsWizardStep: Definer\ & HTMLAttributes\\>
- [Variable: view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/view): const view: View
- [Variable: viewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/viewWithCss): const viewWithCss: View
- [@react-form-builder/components-signature](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/): Interfaces
- [Interface: SignatureProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/interfaces/SignatureProps): The Signature pad properties.
- [Variable: signatureComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureComponent): const signatureComponent: Definer\ = signature
- [Variable: signatureComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureComponentsDescriptions): const signatureComponentsDescriptions: Record\
- [Variable: signatureEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureEnUsComponentsDescriptions): signatureEnUsComponentsDescriptions: object
- [Variable: signatureModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureModel): const signatureModel: Model\
- [@react-form-builder/components-uploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/): Interfaces
- [Interface: FileType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/FileType): Represents a file with upload metadata.
- [Interface: UploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/UploaderProps): The properties of the Uploader component.
- [Type Alias: OnError()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/type-aliases/OnError): OnError = (error, files?) => void
- [Type Alias: OnSuccess()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/type-aliases/OnSuccess): OnSuccess = (files) => void
- [Variable: uploaderComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderComponent): const uploaderComponent: Definer\ = uploader
- [Variable: uploaderComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderComponentsDescriptions): const uploaderComponentsDescriptions: Record\
- [Variable: uploaderEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderEnUsComponentsDescriptions): uploaderEnUsComponentsDescriptions: object
- [Variable: uploaderModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderModel): const uploaderModel: Model\
- [@react-form-builder/core](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/): Enumerations
- [Class: ActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition): Represents the definition of an action.
- [Class: ActionEventArgs](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionEventArgs): Arguments passed to the event handler.
- [Class: Annotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation): Basic metadata class for a React component property for the form builder.
- [Class: AnnotationBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder): The builder class to define the metadata property of the form builder component.
- [Class: ArrayBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder): The builder class to define the metadata property of the form builder component.
- [Class: BaseBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder): The base builder class to define the metadata property of the form builder component.
- [Class: BuilderOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions): Options for building an annotation.
- [Class: BuilderView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView): Represents all the metadata of the form builder components.
- [Class: CalculableResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/CalculableResult): Calculable result.
- [Class: ComponentData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData): This tree of elements contains the data required to display the component. It is synchronized with the ComponentStore tree.
- [Class: ComponentDataEvents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentDataEvents): Represents a class that holds events related to component data.
- [Class: ComponentKeyChangedEventArgs](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentKeyChangedEventArgs): Represents the event argument for the event when the component key changes.
- [Class: ComponentState](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentState): Calculates all the properties of the form view component.
- [Class: ComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore): Component settings for serialization in JSON.
- [Class: ContainerAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ContainerAnnotation): Metadata for the component container property for the form builder.
- [Class: DataValidator](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/DataValidator): Binds all parts of the validation and performs the validation.
- [Class: EventAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/EventAnnotation): Metadata for the component event property for the form builder.
- [Class: FluentLocalizationEngine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/FluentLocalizationEngine): Fluent.js implementation of ILocalizationEngine.
- [Class: Form](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Form): Represents a form that is rendered in Viewer or edited in Builder.
- [Class: FormViewerPropsStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/FormViewerPropsStore): Represents the props passed to the FormViewer Store. Internal use only.
- [Class: Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language): The language to localize the form builder.
- [Class: LocalizationStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/LocalizationStore): Observable storage of localization. Internal use only.
- [Class: Meta](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta): Component metadata for the form builder.
- [Class: Model<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model): Represents component metadata for the form viewer.
- [Class: ModuleAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ModuleAnnotation): Metadata for a component property that is not a property of the component itself,
- [Class: NodeAnnotationBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder): The builder class to define the node metadata property.
- [Class: NoopLocalizationEngine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NoopLocalizationEngine): A no-operation localization engine that provides empty implementations.
- [Class: OneOfBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder): The builder class to define the metadata property of the form builder component.
- [Class: PropertyAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/PropertyAnnotation): Metadata for the component property for the form builder.
- [Class: abstract QuantifierBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder): The abstract builder class to define the metadata property of the form builder component.
- [Class: SomeOfBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder): The builder class to define the metadata property of the form builder component.
- [Class: Store](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store): The form viewer settings. Internal use only.
- [Class: StyleAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/StyleAnnotation): Metadata for the component style property for the form builder.
- [Class: SyncEvent<TSender, TEventArgs>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SyncEvent): Represents a synchronous event that can be subscribed to and invoked. Internal use only.
- [Class: TemplateField](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TemplateField): The field with the form data, contains the value of the nested form. Internal use only.
- [Class: TypedBuilder<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder): The builder class to define the metadata property of the form builder component.
- [Class: View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View): Represents all the metadata of the form viewer components.
- [Enumeration: BiDi](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi): The enumeration of bidirectional text layout types.
- [Enumeration: PersistedFormVersion](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/PersistedFormVersion): The version of the saved form.
- [Function: buildForm()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/buildForm): buildForm(options?): IFormJsonBuilder
- [Function: calculatePropertyValue()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/calculatePropertyValue): calculatePropertyValue(componentProperty, formViewerData): CalculableResult
- [Function: camelCase()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/camelCase): camelCase(input): string
- [Function: checkSlotCondition()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/checkSlotCondition): checkSlotCondition(childStore, parentProps): boolean
- [Function: cloneDeep()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/cloneDeep): cloneDeep\(value, weakMap): T
- [Function: ComponentTree()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/ComponentTree): ComponentTree(props): Element
- [Function: createActionValuesFromObject()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/createActionValuesFromObject): createActionValuesFromObject(obj): ActionValues
- [Function: createNonNullableContext()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/createNonNullableContext): createNonNullableContext\(name, defaultValue): \[() => T, Provider\, Context\\]
- [Function: createProperty()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/createProperty): createProperty(editor): AnnotationBuilder\
- [Function: debounce()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/debounce): debounce\(fn, wait): (...args) => void \| ReturnType\
- [Function: findLanguage()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/findLanguage): findLanguage(languages, language): undefined \| Language
- [Function: findTreeElementDepth()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/findTreeElementDepth): findTreeElementDepth\(value, element?, depth?): undefined \| number
- [Function: fn()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/fn): fn(fnDescriptionBegin, fnDescriptionEnd): TypedBuilder\
- [Function: forwardRef()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/forwardRef): forwardRef\(render): ForwardRefExoticComponent\ \| ForwardRefExoticComponent\ & RefAttributes\\>
- [Function: generateTemplateTypeName()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/generateTemplateTypeName): generateTemplateTypeName(name): string
- [Function: generateUniqueName()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/generateUniqueName): generateUniqueName(prefix, existingNames): string
- [Function: getChildren()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getChildren): getChildren(data, componentTreeItem, componentProps): Record\
- [Function: getDefault()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getDefault): getDefault(annotations): Readonly\\>
- [Function: getDefaultCss()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getDefaultCss): getDefaultCss(annotations): Readonly\\>
- [Function: getEditableFormData()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getEditableFormData): getEditableFormData(form): Record\
- [Function: getKey()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getKey): getKey(): string
- [Function: getTemplateName()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getTemplateName): getTemplateName(typeName): string
- [Function: getValidatorPropertyBlockType()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getValidatorPropertyBlockType): getValidatorPropertyBlockType(ruleKey): string
- [Function: groupBy()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/groupBy): groupBy\(array, predicate): Record\
- [Function: isContainer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isContainer): isContainer(value): value is ContainerAnnotation
- [Function: isEmpty()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isEmpty): isEmpty(value): boolean
- [Function: isEqual()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isEqual): isEqual\(a, b): boolean
- [Function: isEqualWith()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isEqualWith): isEqualWith(a, b, customizer?): boolean
- [Function: isFunctionalProperty()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isFunctionalProperty): isFunctionalProperty(componentProperty?): boolean
- [Function: isLocalizedProperty()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isLocalizedProperty): isLocalizedProperty(componentProperty?): boolean
- [Function: isNull()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isNull): isNull(value): value is null
- [Function: isNumber()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isNumber): isNumber(value): value is number
- [Function: isObject()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isObject): isObject(value): value is Record
- [Function: isPromise()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isPromise): isPromise\(value): value is Promise
- [Function: isProperty()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isProperty): isProperty(value): value is PropertyAnnotation
- [Function: isString()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isString): isString(value): value is string
- [Function: isTemplateType()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isTemplateType): isTemplateType(typeName): boolean
- [Function: isUndefined()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isUndefined): isUndefined(value): value is undefined
- [Function: isValidatorPropertyBlockType()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isValidatorPropertyBlockType): isValidatorPropertyBlockType(type): boolean
- [Function: loadResource()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/loadResource): loadResource(id, href, rel): Promise\
- [Function: merge()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/merge): merge\(target, ...sources): T
- [Function: nameAutorun()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/nameAutorun): nameAutorun(owner, name, params): string
- [Function: namedObserver()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/namedObserver): namedObserver\(displayName, component): T
- [Function: nameObservable()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/nameObservable): nameObservable(owner, params): string
- [Function: needRender()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/needRender): needRender(componentStore, formData): boolean
- [Function: startCase()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/startCase): startCase(input): string
- [Function: SuppressResizeObserverErrors()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/SuppressResizeObserverErrors): SuppressResizeObserverErrors(props): Element
- [Function: toArray()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/toArray): toArray\(annotations?, setup?): Annotation[]
- [Function: toLabeledValues()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/toLabeledValues): toLabeledValues(items, upper): LabeledValue[]
- [Function: toUpper()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/toUpper): toUpper(input): string
- [Function: treeForEach()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/treeForEach): treeForEach\(tree, fn): void
- [Function: uniqueId()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/uniqueId): uniqueId(prefix): string
- [Function: unloadResource()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/unloadResource): unloadResource(id): void
- [Function: upperFirst()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/upperFirst): upperFirst(input): string
- [Function: useAriaAttributes()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaAttributes): useAriaAttributes(options): object
- [Function: useAriaAttributesIds()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaAttributesIds): useAriaAttributesIds(options): AriaAttributesIds
- [Function: useAriaErrorMessage()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaErrorMessage): useAriaErrorMessage(): object
- [Function: useAriaInvalid()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaInvalid): useAriaInvalid(): object
- [Function: useBuilderComponent()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useBuilderComponent): useBuilderComponent\(builderComponent, viewerComponent): ComponentType\
- [Function: useBuilderValue()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useBuilderValue): useBuilderValue\(value, builderValue): T
- [Function: useDisposable()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useDisposable): useDisposable\(factory): undefined \| T
- [Function: useErrorMessage()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useErrorMessage): useErrorMessage(): undefined \| string
- [Function: useErrorModel()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useErrorModel): useErrorModel(): Model\
- [Function: useMobxConfig()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useMobxConfig): useMobxConfig(): void
- [Function: useModalComponentData()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useModalComponentData): useModalComponentData(parentComponentData, modalType): ComponentData
- [Function: useModalType()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useModalType): useModalType(): undefined \| string
- [Function: useTooltipType()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useTooltipType): useTooltipType(): undefined \| string
- [Interface: BaseCompilationResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BaseCompilationResult): The result of compiling of anything. Internal use only.
- [Interface: BuilderComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent): Description of the React component that connects to the form builder.
- [Interface: ComponentField](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentField): Describes the field of the component.
- [Interface: ComponentMetadataEventListeners](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners): Component metadata event listeners.
- [Interface: ComponentProperty<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty): The value of the component property.
- [Interface: ComponentTreeProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentTreeProps): Properties of a form component tree element.
- [Interface: Definer<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer): The builder class to define the metadata of the form builder component.
- [Interface: EmbeddedFormProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/EmbeddedFormProps): The embedded form component properties.
- [Interface: ErrorWrapperProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps): Properties of the React component that wraps the form view component and displays validation errors.
- [Interface: Field](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field): Field with the form data.
- [Interface: FormViewerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps): Form viewer React component properties.
- [Interface: FormViewerWrapperComponentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerWrapperComponentProps): Represents the props for the WrapperComponent. WrapperComponent is a component that wraps the form viewer. Can be added externally.
- [Interface: IComponentBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder): Interface for configuring a specific component within the form.
- [Interface: IComponentDataFactory](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentDataFactory): The factory for creating ComponentData instances. Internal use only.
- [Interface: IComponentState](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState): Calculates all the properties of the form view component.
- [Interface: IDataRootProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IDataRootProvider): Provides the root component for the data in the component tree.
- [Interface: IEventHandlerBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder): Interface for defining event handlers for a component.
- [Interface: IForm](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm): A form.
- [Interface: IFormData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData): The interface for accessing the form data.
- [Interface: IFormJsonBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder): Interface for building a form JSON.
- [Interface: IFormViewer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer): The form viewer settings interface.
- [Interface: ILocalizationEngine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine): The form localization engine.
- [Interface: ILocalizationStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationStore): Localization of the form.
- [Interface: InternalErrorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/InternalErrorProps): React component properties that display an internal form view error. Internal use only.
- [Interface: IStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore): The form viewer settings interface.
- [Interface: IValidationBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder): Interface for defining validation rules for a component.
- [Interface: IView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView): Represents all the metadata of the form viewer components.
- [Interface: LabeledValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue): The element with the value and the label.
- [Interface: LocalizationError](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError): Localization error class.
- [Interface: PersistedForm](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/PersistedForm): The format for saving a form designed in Form Builder.
- [Interface: ScreenProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ScreenProps): Properties of the root component of the form. Internal use only.
- [Interface: SuppressResizeObserverErrorsProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/SuppressResizeObserverErrorsProps): Represents the props for the SuppressResizeObserverErrors component. Internal use only.
- [Interface: WrapperProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps): React wrapper component properties.
- [Type Alias: ActionData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData): ActionData = object
- [Type Alias: ActionEventHandler()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler): ActionEventHandler = (e) => void \| Promise\
- [Type Alias: ActionHandler()<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionHandler): ActionHandler\ = (e, params) => void \| Promise\
- [Type Alias: ActionParameters](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters): ActionParameters = Record\
- [Type Alias: ActionsInitializer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionsInitializer): ActionsInitializer = (props, def) => Record\
- [Type Alias: ActionType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionType): ActionType = "common" \| "code" \| "custom"
- [Type Alias: ActionValues](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues): ActionValues = Record\
- [Type Alias: Annotations<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations): Annotations\ = \{ \[key in keyof T\]: BaseBuilder\ \| undefined \}
- [Type Alias: AnnotationType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AnnotationType): AnnotationType = "Property" \| "Container" \| "Event" \| "Module" \| "Style"
- [Type Alias: Arguments](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Arguments): Arguments = Record\
- [Type Alias: ArgumentValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ArgumentValue): ArgumentValue = PrimitiveArgumentValue \| FunctionArgumentValue
- [Type Alias: AriaAttributesIds](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesIds): AriaAttributesIds = Record\, string\>
- [Type Alias: AriaAttributesOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesOptions): AriaAttributesOptions = object
- [Type Alias: BoundValueSchema](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BoundValueSchema): BoundValueSchema = object
- [Type Alias: BuilderMode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderMode): BuilderMode = "builder" \| "viewer"
- [Type Alias: BuilderSetup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup): BuilderSetup = Partial\
- [Type Alias: BuilderTheme](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderTheme): BuilderTheme = "dark" \| "light"
- [Type Alias: CellInfo](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CellInfo): CellInfo = object
- [Type Alias: ComponentDescription](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDescription): ComponentDescription = I18nItem & object
- [Type Alias: ComponentDeviceStyle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDeviceStyle): ComponentDeviceStyle = object
- [Type Alias: ComponentFeature](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeature): ComponentFeature = object
- [Type Alias: ComponentFeatures](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeatures): ComponentFeatures = Record\
- [Type Alias: ComponentKey](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKey): ComponentKey = string
- [Type Alias: ComponentKind](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKind): ComponentKind = "container" \| "component" \| "template" \| "repeater"
- [Type Alias: ComponentLibraryDescription](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription): ComponentLibraryDescription = object
- [Type Alias: ComponentLocalizer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLocalizer): ComponentLocalizer = (componentStore, language) => Record\
- [Type Alias: ComponentPropertiesContext](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertiesContext): ComponentPropertiesContext = object
- [Type Alias: ComponentPropertyBindType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType): ComponentPropertyBindType = "single" \| "array"
- [Type Alias: ComponentPropertyComputeType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyComputeType): ComponentPropertyComputeType = "function" \| "localization"
- [Type Alias: ComponentPropertyName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyName): ComponentPropertyName = string
- [Type Alias: ComponentPropsLocalization](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropsLocalization): ComponentPropsLocalization = Record\
- [Type Alias: ComponentRole](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentRole): ComponentRole = "label" \| "tooltip" \| "error-message" \| "modal" \| string
- [Type Alias: ComponentsLocalization](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentsLocalization): ComponentsLocalization = Record\
- [Type Alias: ComponentStateFactory()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStateFactory): ComponentStateFactory = (data, store, context?) => IComponentState
- [Type Alias: ComponentStoreLocalizer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStoreLocalizer): ComponentStoreLocalizer = (componentStore) => Record\
- [Type Alias: ComponentStyle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStyle): ComponentStyle = object
- [Type Alias: ComputeChildren()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComputeChildren): ComputeChildren = (componentData, componentProps) => Record\
- [Type Alias: Css](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css): Css = object
- [Type Alias: CssLoaderType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CssLoaderType): CssLoaderType = BiDi \| "common"
- [Type Alias: CssPart](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CssPart): CssPart = "css" \| "wrapperCss"
- [Type Alias: CustomActions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomActions): CustomActions = Record\
- [Type Alias: CustomValidationRules](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRules): CustomValidationRules = Record\
- [Type Alias: CustomValidationRuleSettings](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRuleSettings): CustomValidationRuleSettings = object
- [Type Alias: DataBindingType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType): DataBindingType = "oneWay" \| "twoWay" \| "none"
- [Type Alias: DataKeyType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataKeyType): DataKeyType = string \| number \| symbol
- [Type Alias: DefineActionHelper()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DefineActionHelper): DefineActionHelper = \(name, func, params?, description?) => ActionDefinition
- [Type Alias: DefinerData<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DefinerData): DefinerData\ = object
- [Type Alias: Device](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Device): Device = "any" \| "desktop" \| "mobile" \| "tablet"
- [Type Alias: DeviceStyle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DeviceStyle): DeviceStyle = object
- [Type Alias: EditorType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EditorType): EditorType = string
- [Type Alias: ErrorMap](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap): ErrorMap = object
- [Type Alias: ErrorMessageLocalizer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMessageLocalizer): ErrorMessageLocalizer = (value) => string[] \| undefined
- [Type Alias: EventHandler()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventHandler): EventHandler = (...args) => unknown
- [Type Alias: EventName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventName): EventName = string
- [Type Alias: FieldType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FieldType): FieldType = "simple" \| "template" \| "repeater"
- [Type Alias: FirstParameter<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FirstParameter): FirstParameter\ = Parameters\\[0\]
- [Type Alias: FormBuilderComponentIconName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormBuilderComponentIconName): FormBuilderComponentIconName = typeof iconsList\[number\]
- [Type Alias: FormOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormOptions): FormOptions = object
- [Type Alias: FormValidator()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidator): FormValidator = (data) => Promise\ \| undefined\>
- [Type Alias: FormValidators](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidators): FormValidators = FormValidator[]
- [Type Alias: FormViewerValidationRules](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerValidationRules): FormViewerValidationRules = object
- [Type Alias: FormViewerWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper): FormViewerWrapper = ComponentType\
- [Type Alias: Func()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func): Func = (...arg) => void \| Promise\
- [Type Alias: FunctionArgumentValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FunctionArgumentValue): FunctionArgumentValue = object
- [Type Alias: GetInitialDataFn()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/GetInitialDataFn): GetInitialDataFn = () => unknown
- [Type Alias: HtmlAttribute](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/HtmlAttribute): HtmlAttribute = Record\
- [Type Alias: I18nItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/I18nItem): I18nItem = object
- [Type Alias: iconsList](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/iconsList): iconsList = readonly \["Breadcrumb", "Button", "Card", "Checkbox", "CollectionEditor", "Container", "Content", "CustomBlock", "CustomControl", "DatePicker", "Default", "Dropdown", "Dropzone", "ErrorMessage", "Grid", "GridLayout", "GridView", "Image", "Input", "Label", "Link", "Footer", "Header", "Sidebar", "Menu", "Message", "NumberFormat", "PatternFormat", "ProgressCircle", "ProgressLine", "RadioGroup", "Repeater", "RichTextEditor", "Search", "Signature", "Sparks", "StaticContent", "Tab", "TextArea", "TimePicker", "Toggle", "Tooltip", "TreePicker", "Uploader"\]
- [Type Alias: IDisposable](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/IDisposable): IDisposable = object
- [Type Alias: InsertRestrictionFn()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn): InsertRestrictionFn = (self, target, slot?) => boolean
- [Type Alias: LanguageFullCode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode): LanguageFullCode = ` $-${string} `
- [Type Alias: LocalizationType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationType): LocalizationType = "component" \| "tooltip" \| "modal" \| string
- [Type Alias: LocalizationValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue): LocalizationValue = Record\
- [Type Alias: MessagesMap](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/MessagesMap): MessagesMap = Record\\>
- [Type Alias: ModalComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ModalComponentStore): ModalComponentStore = object
- [Type Alias: NamedActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NamedActionDefinition): NamedActionDefinition = object
- [Type Alias: NodeEditorType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType): NodeEditorType = "node" \| "string"
- [Type Alias: ParameterDefinition<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterDefinition): ParameterDefinition\ = \[PropertyKey\, ParameterType\]
- [Type Alias: ParameterName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterName): ParameterName = string
- [Type Alias: ParameterType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterType): ParameterType = "string" \| "number" \| "boolean" \| "function"
- [Type Alias: PreAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation): PreAnnotation = Partial\\> & Pick\
- [Type Alias: PrimitiveArgumentValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PrimitiveArgumentValue): PrimitiveArgumentValue = string \| number \| boolean
- [Type Alias: PropertyBlockType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PropertyBlockType): PropertyBlockType = "component" \| "tooltip" \| "modal" \| string
- [Type Alias: PropertyKey<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PropertyKey): PropertyKey\ = keyof T & string
- [Type Alias: ReactProperty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ReactProperty): ReactProperty = object
- [Type Alias: Rel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Rel): Rel = "stylesheet" \| string
- [Type Alias: ResolvedValidator()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ResolvedValidator): ResolvedValidator = (value, store, getFormData?) => Promise\
- [Type Alias: RuleValidator()<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator): RuleValidator\ = (value, store, args?, formData?) => RuleValidatorResult \| Promise\
- [Type Alias: RuleValidatorResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult): RuleValidatorResult = string \| boolean
- [Type Alias: SchemaResolver()<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaResolver): SchemaResolver\ = (value) => ResolvedValidator
- [Type Alias: SchemaType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaType): SchemaType = keyof SchemaTypeMap
- [Type Alias: SchemaTypeMap](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap): SchemaTypeMap = object
- [Type Alias: SetInitialDataFn()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SetInitialDataFn): SetInitialDataFn = (key, value) => void
- [Type Alias: Setter()<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Setter): Setter\ = (value) => void
- [Type Alias: SyncEventHandler()<TSender, TEventArgs>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SyncEventHandler): SyncEventHandler\ = (source, eventArgs) => void
- [Type Alias: TemplateProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/TemplateProps): TemplateProps = Omit\
- [Type Alias: TypedLocalization](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/TypedLocalization): TypedLocalization = Partial\\>
- [Type Alias: ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages): ValidationMessages = string] \| [MessagesMap \| undefined
- [Type Alias: ValidationResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult): ValidationResult = object
- [Type Alias: ValidationRule](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRule): ValidationRule = object
- [Type Alias: ValidationRuleParameter](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleParameter): ValidationRuleParameter = object
- [Type Alias: ValidationRuleSet](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSet): ValidationRuleSet = Record\
- [Type Alias: ValidationRuleSettings](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSettings): ValidationRuleSettings = object
- [Type Alias: ValidatorFactory()<Params>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorFactory): ValidatorFactory\ = (args) => RuleValidator
- [Type Alias: Validators](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Validators): Validators = Partial\\>
- [Type Alias: ValidatorType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorType): ValidatorType = "internal" \| "custom"
- [Type Alias: ViewMode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ViewMode): ViewMode = "desktop" \| "mobile" \| "tablet"
- [Variable: ActionEventArgsDeclaration](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/ActionEventArgsDeclaration): const ActionEventArgsDeclaration string\n\n  /\\\n   \ The component that triggered the event.\n   \/\n  readonly sender Record\\n\n  /\\\n   \ The index of the component in the array, if the component is in the array.\n   \/\n  readonly index? Record\\n\n  /\\\n   \ Sets current props of component.\n   \/\n  readonly setUserDefinedProps Record\) =\> void\n\n  /\\\n   \ The form viewer settings.\n   \/\n  readonly store any\[\]\n\n  /\\\n   \ @returns the event handled by the event handler.\n   \/\n  get event() any\n  \n  /\\\n   \ @returns the object for reading and changing form data.\n   \/\n  get data() Record\ \| undefined\n\n  /\\\n   \ @returns the object to read and modify root form data.\n   \/\n  get rootData() CellInfo\n\}\n"
- [Variable: array](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/array): const array: ArrayBuilder\
- [Variable: AsyncFunction](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/AsyncFunction): const AsyncFunction: Function
- [Variable: boolean](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/boolean): const boolean: TypedBuilder\
- [Variable: BuilderModeProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/BuilderModeProvider): BuilderModeProvider: Provider\
- [Variable: BuilderThemeProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/BuilderThemeProvider): BuilderThemeProvider: Provider\
- [Variable: CellInfoContextProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/CellInfoContextProvider): CellInfoContextProvider: Provider\
- [Variable: cfComponentIsPreset](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfComponentIsPreset): const cfComponentIsPreset: "component-is-preset" = 'component-is-preset'
- [Variable: cfDisableActionEditors](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableActionEditors): const cfDisableActionEditors: "disable-action-editors" = 'disable-action-editors'
- [Variable: cfDisableAdditionalProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableAdditionalProperties): const cfDisableAdditionalProperties: "disable-additional-properties" = 'disable-additional-properties'
- [Variable: cfDisableComponentRemove](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableComponentRemove): const cfDisableComponentRemove: "disable-component-remove" = 'disable-component-remove'
- [Variable: cfDisableMainComponentProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableMainComponentProperties): const cfDisableMainComponentProperties: "disable-main-component-properties" = 'disable-main-component-properties'
- [Variable: cfDisableStyleProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableStyleProperties): const cfDisableStyleProperties: "disable-style-properties" = 'disable-style-properties'
- [Variable: cfDisableStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableStyles): const cfDisableStyles: "disable-component-styling" = 'disable-component-styling'
- [Variable: cfDisableStylesForClassNameEditor](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableStylesForClassNameEditor): const cfDisableStylesForClassNameEditor: "disable-styles-for-classname-editor" = 'disable-styles-for-classname-editor'
- [Variable: cfDisableTooltipProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableTooltipProperties): const cfDisableTooltipProperties: "disable-tooltip-properties" = 'disable-tooltip-properties'
- [Variable: cfDisableWrapperStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableWrapperStyles): const cfDisableWrapperStyles: "disable-component-wrapper-styling" = 'disable-component-wrapper-styling'
- [Variable: cfEnableInlineStylesEditor](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfEnableInlineStylesEditor): const cfEnableInlineStylesEditor: "enable-inline-styles-editor" = 'enable-inline-styles-editor'
- [Variable: cfHideFromComponentPalette](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfHideFromComponentPalette): const cfHideFromComponentPalette: "hide-from-component-palette" = 'hide-from-component-palette'
- [Variable: className](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/className): const className: Annotation
- [Variable: color](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/color): const color: TypedBuilder\
- [Variable: commonStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/commonStyles): const commonStyles: object
- [Variable: ComponentDataProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/ComponentDataProvider): ComponentDataProvider: Provider\
- [Variable: containerStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/containerStyles): const containerStyles: object
- [Variable: coreComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/coreComponentsDescriptions): const coreComponentsDescriptions: Record\
- [Variable: createAnnotation()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/createAnnotation): const createAnnotation: \(editor) => AnnotationBuilder\ = AnnotationBuilder.create
- [Variable: createView()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/createView): const createView: (models) => View = View.create
- [Variable: cssSize](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cssSize): const cssSize: AnnotationBuilder\
- [Variable: date](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/date): const date: TypedBuilder\
- [Variable: DefaultWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/DefaultWrapper): const DefaultWrapper: ForwardRefExoticComponent\ \| ForwardRefExoticComponent\ & RefAttributes\\>
- [Variable: define()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/define): const define: \(component, displayName?) => Definer\ = Definer.define
- [Variable: definePreset()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/definePreset): const definePreset: (name, components) => Definer\ = Definer.definePreset
- [Variable: DidMountEvent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/DidMountEvent): const DidMountEvent: "onDidMount" = 'onDidMount'
- [Variable: disabled](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/disabled): const disabled: TypedBuilder\
- [Variable: embeddedFormMeta](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/embeddedFormMeta): const embeddedFormMeta: Meta
- [Variable: embeddedFormModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/embeddedFormModel): const embeddedFormModel: Model\
- [Variable: emotionCache](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/emotionCache): const emotionCache: object
- [Variable: emptyComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/emptyComponentStore): const emptyComponentStore: ComponentStore
- [Variable: errorMessageModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/errorMessageModel): const errorMessageModel: Model\
- [Variable: event](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/event): const event: AnnotationBuilder\
- [Variable: FormViewer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/FormViewer): const FormViewer: (props) => Element
- [Variable: FormViewerLite()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/FormViewerLite): const FormViewerLite: (props) => Element
- [Variable: globalDefaultLanguage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/globalDefaultLanguage): const globalDefaultLanguage: Language
- [Variable: htmlAttributes](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/htmlAttributes): const htmlAttributes: AnnotationBuilder\
- [Variable: IFormDataDeclaration](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/IFormDataDeclaration): const IFormDataDeclaration Record\\n\n  /\\\n   \ @returns the object to read and modify parent data (available for array elements).\n   \/\n  get parentData() Record\\n\n  /\\\n   \ @returns the \{@link Record\} with all validation error messages.\n   \/\n  get errors() boolean\n\n  /\\\n   \ @returns A user-defined key-value observable storage. Utilize it to store and share any custom data.\n   \/\n  get state() string) Promise\\n\n  /\\\n   \ Returns the validation results without triggering an events and changing the state of the form.\n   \ @returns the validation results.\n   \/\n  getValidationResult boolean\n\n  /\\\n   \ Sets the form to its default value.\n   \ @param clearInitialData if true, then also clear the initial data. Defaults to true.\n   \/\n  reset(clearInitialData? void\n\n  /\\\n   \ Clears the form data.\n   \ @param clearInitialData if true, then also clear the initial data. Defaults to true.\n   \/\n  clear(clearInitialData? void\n\n  /\\\n   \ @returns the index in the array if the component is in the component array.\n   \/\n  index?: number\n\}"
- [Variable: internalErrorModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/internalErrorModel): const internalErrorModel: Model\
- [Variable: isUniqueKey](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/isUniqueKey): const isUniqueKey: RuleValidator\
- [Variable: key](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/key): const key: Annotation
- [Variable: KeySymbol](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/KeySymbol): const KeySymbol: typeof KeySymbol
- [Variable: node](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/node): const node: NodeAnnotationBuilder\
- [Variable: nodeArray](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/nodeArray): const nodeArray: NodeAnnotationBuilder\
- [Variable: nonNegNumber](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/nonNegNumber): const nonNegNumber: TypedBuilder\
- [Variable: number](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/number): const number: TypedBuilder\
- [Variable: object](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/object): const object: TypedBuilder\
- [Variable: oneOf()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/oneOf): const oneOf: \(...values) => OneOfBuilder\
- [Variable: oneOfStrict()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/oneOfStrict): const oneOfStrict: \(...values) => OneOfBuilder\
- [Variable: readOnly](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/readOnly): const readOnly: TypedBuilder\
- [Variable: renderWhen](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/renderWhen): const renderWhen: TypedBuilder\
- [Variable: required](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/required): const required: TypedBuilder\
- [Variable: screenModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/screenModel): const screenModel: Model\ & RefAttributes\\>
- [Variable: size](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/size): const size: TypedBuilder\
- [Variable: slotModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/slotModel): const slotModel: Model\
- [Variable: someOf()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/someOf): const someOf: \(...values) => SomeOfBuilder\
- [Variable: StoreContext](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/StoreContext): StoreContext: Context\
- [Variable: StoreProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/StoreProvider): StoreProvider: Provider\
- [Variable: string](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/string): const string: TypedBuilder\
- [Variable: stringNode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/stringNode): const stringNode: NodeAnnotationBuilder\
- [Variable: time](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/time): const time: TypedBuilder\
- [Variable: timeFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/timeFormat): const timeFormatmmmm:ss'
- [Variable: tooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/tooltipProps): const tooltipProps: AnnotationBuilder\
- [Variable: tooltipType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/tooltipType): const tooltipType: TypedBuilder\
- [Variable: useBuilderMode()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useBuilderMode): useBuilderMode: () => BuilderMode
- [Variable: useBuilderTheme()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useBuilderTheme): useBuilderTheme: () => BuilderTheme
- [Variable: useComponentData()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useComponentData): useComponentData: () => ComponentData
- [Variable: useStore()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useStore): useStore: () => Store
- [Variable: useViewerProps()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useViewerProps): useViewerProps: () => T
- [Variable: validation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/validation): const validation: AnnotationBuilder\
- [Variable: ViewerPropsProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/ViewerPropsProvider): ViewerPropsProvider: Provider\\>
- [Variable: WillUnmountEvent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/WillUnmountEvent): const WillUnmountEvent: "onWillUnmount" = 'onWillUnmount'
- [@react-form-builder/designer-bundle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/): Namespaces
- [Class: ActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/classes/ActionDefinition): Represents the definition of an action.
- [Class: Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/classes/Language): The language to localize the form builder.
- [Function: buildForm()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/buildForm): buildForm(options?): IFormJsonBuilder
- [Function: createBuilderView()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/createBuilderView): createBuilderView(components): BuilderView
- [Function: renderFormBuilder()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilder): renderFormBuilder(elementId, props): Root
- [Function: renderFormBuilderTo()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilderTo): renderFormBuilderTo(container, props): Root
- [fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/): Interfaces
- [Interface: FastQrProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/interfaces/FastQrProps): The Fast QR component properties.
- [Variable: fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrComponent): const fastQrComponent: Definer\ = fastQr
- [Variable: fastQrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrComponentsDescriptions): const fastQrComponentsDescriptions: Record\
- [Variable: fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrEnUsComponentsDescriptions): fastQrEnUsComponentsDescriptions: object
- [Variable: fastQrModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrModel): const fastQrModel: Model\
- [googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/): Interfaces
- [Function: toAddress()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/functions/toAddress): toAddress(components): Address
- [Interface: GoogleMapProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/interfaces/GoogleMapProps): Props for the GoogleMap component.
- [Type Alias: Address](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/Address): Address = object
- [Type Alias: MapMarker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/MapMarker): MapMarker = object
- [Variable: googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapComponent): const googleMapComponent: Definer\ = googleMap
- [Variable: googleMapComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapComponentsDescriptions): const googleMapComponentsDescriptions: Record\
- [Variable: googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapEnUsComponentsDescriptions): googleMapEnUsComponentsDescriptions: object
- [Variable: googleMapModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapModel): const googleMapModel: Model\
- [richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/): Interfaces
- [Interface: RichTextEditorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/interfaces/RichTextEditorProps): The Rich text editor component properties.
- [Variable: richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextComponent): const richTextComponent: Definer\ = richTextEditor
- [Variable: richTextEditorComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextEditorComponentsDescriptions): const richTextEditorComponentsDescriptions: Record\
- [Variable: richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextEditorEnUsComponentsDescriptions): richTextEditorEnUsComponentsDescriptions: object
- [Variable: richTextModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextModel): const richTextModel: Model\
- [rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/): Interfaces
- [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader): formEngineRsuiteCssLoader(): Promise\
- [Function: ltrCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/ltrCssLoader): ltrCssLoader(): Promise\
- [Function: RsLocalizationWrapper()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/RsLocalizationWrapper): RsLocalizationWrapper(props): Element
- [Function: rtlCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/rtlCssLoader): rtlCssLoader(): Promise\
- [Interface: RsAutoCompleteProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsAutoCompleteProps): The properties of the RsAutoComplete component.
- [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps): Props for a single breadcrumb item.
- [Interface: RsBreadcrumbProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbProps): Props for the RsBreadcrumb component.
- [Interface: RsCalendarProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsCalendarProps): Props for the RsCalendar component.
- [Interface: RsCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsCardProps): Props for the RsCard component.
- [Interface: RsContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsContainerProps): Props for the RsContainer component.
- [Interface: RsDatePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsDatePickerProps): Props for the RsDatePicker component.
- [Interface: RsDropdownProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsDropdownProps): Props for the RsDropdown component.
- [Interface: RsErrorMessageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps): The properties of RsErrorMessage component.
- [Interface: RsHeaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsHeaderProps): Props for the RsHeader component.
- [Interface: RsImageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsImageProps): Props for the RsImage component.
- [Interface: RsInputProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsInputProps): Props for the RsInput component.
- [Interface: RsLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsLabelProps): Props for the RsLabel component.
- [Interface: RsLinkProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsLinkProps): Props for the RsLink component.
- [Interface: RsMenuProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsMenuProps): Props for the RsMenu component.
- [Interface: RsModalLayoutProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsModalLayoutProps): Props for the RsModalLayout component.
- [Interface: RsModalProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsModalProps): Props for the RsModal component.
- [Interface: RsNumberFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsNumberFormatProps): Props for the RsNumberFormat component.
- [Interface: RsPatternFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsPatternFormatProps): Props for the RsPatternFormat component.
- [Interface: RsRadioGroupProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsRadioGroupProps): Props for the RsRadioGroup component.
- [Interface: RsSearchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsSearchProps): Props for the RsSearch component.
- [Interface: RsStaticContentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsStaticContentProps): Props for the RsStaticContent component.
- [Interface: RsTabProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTabProps): Props for the RsTab component.
- [Interface: RsTagPickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTagPickerProps): Props for the RsTagPicker component.
- [Interface: RsTextAreaProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTextAreaProps): Props for the RsTextArea component.
- [Interface: RsTimePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTimePickerProps): Props for the RsTimePicker component.
- [Interface: RsTooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps): The properties of RsTooltip component.
- [Interface: RsUploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsUploaderProps): Props for the RsUploader component.
- [Interface: RsWizardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardProps): Props for the RsWizard component.
- [Interface: RsWizardStepProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardStepProps): Props for the RsWizardStep component.
- [Type Alias: LoadCallback()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadCallback): LoadCallback = (newData) => void
- [Type Alias: LoadDataHandler()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadDataHandler): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => void
- [Type Alias: MenuItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/MenuItem): MenuItem = object
- [Type Alias: RsTabItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/RsTabItem): RsTabItem = object
- [Variable: builderViewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/builderViewWithCss): const builderViewWithCss: BuilderView
- [Variable: components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/components): const components: BuilderComponent[]
- [Variable: models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/models): const models: Model\[]
- [Variable: rsAutoComplete](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsAutoComplete): const rsAutoComplete: Definer\
- [Variable: rsBreadcrumb](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsBreadcrumb): const rsBreadcrumb: Definer\
- [Variable: rsButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsButton): const rsButton: Definer\
- [Variable: rsCalendar](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCalendar): const rsCalendar: Definer\
- [Variable: rsCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCard): const rsCard: Definer\
- [Variable: rsCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCheckbox): const rsCheckbox: Definer\\>
- [Variable: rsContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsContainer): const rsContainer: Definer\\>
- [Variable: rsDatePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDatePicker): const rsDatePicker: Definer\
- [Variable: rsDivider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDivider): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\>
- [Variable: rsDropdown](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDropdown): const rsDropdown: Definer\
- [Variable: rsErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsErrorMessage): const rsErrorMessage: Definer\
- [Variable: rsHeader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsHeader): const rsHeader: Definer\
- [Variable: rsImage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsImage): const rsImage: Definer\
- [Variable: rsInput](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsInput): const rsInput: Definer\
- [Variable: rsLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsLabel): const rsLabel: Definer\
- [Variable: rsLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsLink): const rsLink: Definer\
- [Variable: rsMenu](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsMenu): const rsMenu: Definer\
- [Variable: rsMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsMessage): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\>
- [Variable: rsModal](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsModal): const rsModal: Definer\
- [Variable: rsModalLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsModalLayout): const rsModalLayout: Definer\
- [Variable: rsNumberFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsNumberFormat): const rsNumberFormat: Definer\
- [Variable: rsPatternFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPatternFormat): const rsPatternFormat: Definer\
- [Variable: rsPlaceholderGraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGraph): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\>
- [Variable: rsPlaceholderGrid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGrid): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\>
- [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderParagraph): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\>
- [Variable: rsProgressCircle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsProgressCircle): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\>
- [Variable: rsProgressLine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsProgressLine): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\>
- [Variable: rsRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsRadioGroup): const rsRadioGroup: Definer\
- [Variable: rsSearch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsSearch): const rsSearch: Definer\
- [Variable: rsStaticContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsStaticContent): const rsStaticContent: Definer\
- [Variable: rsTab](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTab): const rsTab: Definer\
- [Variable: rsTagPicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTagPicker): const rsTagPicker: Definer\
- [Variable: rsTextArea](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTextArea): const rsTextArea: Definer\
- [Variable: rsTimePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTimePicker): const rsTimePicker: Definer\
- [Variable: rsToggle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsToggle): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\>
- [Variable: rsTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTooltip): const rsTooltip: Definer\
- [Variable: rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponents): const rSuiteComponents: Definer\[] = []
- [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponentsDescriptions): const rSuiteComponentsDescriptions: Record\
- [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteEnUsComponentsDescriptions): rSuiteEnUsComponentsDescriptions: object
- [Variable: rsUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsUploader): const rsUploader: Definer\
- [Variable: rsWizard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsWizard): const rsWizard: Definer\
- [Variable: rsWizardStep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsWizardStep): const rsWizardStep: Definer\ & HTMLAttributes\\>
- [Variable: view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/view): const view: View
- [Variable: viewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/viewWithCss): const viewWithCss: View
- [rSuiteTableComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/): Variables
- [Variable: rSuiteTableComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/rSuiteTableComponents): const rSuiteTableComponents: Definer\[] = []
- [Variable: rSuiteTableComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/rSuiteTableComponentsDescriptions): const rSuiteTableComponentsDescriptions: Record\
- [Variable: rSuiteTableEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/rSuiteTableEnUsComponentsDescriptions): rSuiteTableEnUsComponentsDescriptions: object
- [Variable: tableModels](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/tableModels): const tableModels: Model\[]
- [signatureComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/): Interfaces
- [Interface: SignatureProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/interfaces/SignatureProps): The Signature pad properties.
- [Variable: signatureComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureComponent): const signatureComponent: Definer\ = signature
- [Variable: signatureComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureComponentsDescriptions): const signatureComponentsDescriptions: Record\
- [Variable: signatureEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureEnUsComponentsDescriptions): signatureEnUsComponentsDescriptions: object
- [Variable: signatureModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureModel): const signatureModel: Model\
- [@react-form-builder/designer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/): Enumerations
- [Class: BuilderView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/classes/BuilderView): Represents all the metadata of the form builder components.
- [Class: PresetComponentLocalStorage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/classes/PresetComponentLocalStorage): Class for working with the preset components in the local storage.
- [Enumeration: Section](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/enumerations/Section): Component property editor section.
- [Function: ActionCell()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/functions/ActionCell): ActionCell(props): Element
- [Function: CheckCell()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/functions/CheckCell): CheckCell(props): Element
- [Function: EditableTable()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/functions/EditableTable): EditableTable(props): Element
- [Function: InputCell()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/functions/InputCell): InputCell(props): Element
- [Function: makeColumns()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/functions/makeColumns): makeColumns(columns): Element[]
- [Function: SelectCell()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/functions/SelectCell): SelectCell(props): Element
- [Interface: ActionCellProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/ActionCellProps): The properties of ActionCell component.
- [Interface: AnnotationEditorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/AnnotationEditorProps): Props for the AnnotationEditor component.
- [Interface: CalculableEditorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/CalculableEditorProps): Represents the props used to edit a calculable property.
- [Interface: ColumnDescription](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/ColumnDescription): The description of the table column.
- [Interface: EditableTableProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/EditableTableProps): The React component properties for the EditableTable component.
- [Interface: EditableTableState](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/EditableTableState): The state of the EditableTable component.
- [Interface: FormBuilderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/FormBuilderProps): Properties of the React Form builder component.
- [Interface: IFormBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/IFormBuilder): The form builder settings interface.
- [Interface: IFormStorage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/IFormStorage): Interface for storing forms in an external storage.
- [Interface: InputCellProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/InputCellProps): The properties of InputCell component.
- [Interface: IPresetComponentOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/IPresetComponentOptions): Interface for configuring preset component options.
- [Interface: PresetComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/PresetComponent): The preset component settings.
- [Interface: SelectCellProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/SelectCellProps): The properties of SelectCell component.
- [Type Alias: ComputePropertiesParameters](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/ComputePropertiesParameters): ComputePropertiesParameters = object
- [Type Alias: ComputeTypeParams<T>](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/ComputeTypeParams): ComputeTypeParams\ = ComputePropertiesParameters\[T\]
- [Type Alias: CustomizableKey](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/CustomizableKey): CustomizableKey = typeof CustomizableZone extends Set\ ? U : never
- [Type Alias: CustomizationMap](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/CustomizationMap): CustomizationMap = Partial\\>
- [Type Alias: FormBuilderI18n](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/FormBuilderI18n): FormBuilderI18n = object
- [Type Alias: FormBuilderI18nData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/FormBuilderI18nData): FormBuilderI18nData = object
- [Type Alias: FormBuilderTheme](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/FormBuilderTheme): FormBuilderTheme = "light" \| "dark" \| "system"
- [Type Alias: GenerateJsonFormSchemaOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/GenerateJsonFormSchemaOptions): GenerateJsonFormSchemaOptions = object
- [Type Alias: LocalizationComputeCodeParams](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/LocalizationComputeCodeParams): LocalizationComputeCodeParams = object
- [Type Alias: Options](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/type-aliases/Options): Options = object
- [Variable: CustomizableZone](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/variables/CustomizableZone): const CustomizableZone: Set\
- [Variable: FormBuilder()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/variables/FormBuilder): const FormBuilder: (props) => Element
- [Variable: SCell](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/variables/SCell): const SCell: StyledComponent\, string \| number\> & RefAttributes\ & object, \{ \}, \{ \}\>
- [Variable: useFormBuilder()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/variables/useFormBuilder): useFormBuilder: () => IFormBuilder
- [@react-form-builder/json-schema-generator](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/json-schema-generator/): Functions
- [Function: createSchema()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/json-schema-generator/functions/createSchema): createSchema(components, descriptions?) string; $id? string; $schema? JSONSchema\; additionalProperties? MaybeReadonlyArray\\>; anyOf? any; contains? "base64" \| "7bit" \| "8bit" \| "binary" \| "ietf-token" \| "quoted-printable" \| "x-token"; contentMediaType? any; definitions? Record\ \| MaybeReadonlyArray\\>; description? JSONSchema\; enum? MaybeReadonlyArray\; exclusiveMaximum? number; format? JSONSchema\; items? number; maxItems? number; maxProperties? number; minItems? number; minProperties? number; not? MaybeReadonlyArray\\>; pattern? Record\\>; properties? JSONSchema\; readOnly? MaybeReadonlyArray\; then? string; type? boolean; writeOnly?: boolean; \}
- [@react-form-builder/viewer-bundle-premium](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/): Namespaces
- [Class: ActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/classes/ActionDefinition): Represents the definition of an action.
- [Class: Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/classes/Language): The language to localize the form builder.
- [Function: buildForm()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/functions/buildForm): buildForm(options?): IFormJsonBuilder
- [Function: renderFormViewer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/functions/renderFormViewer): renderFormViewer(elementId, props): Root
- [Function: renderFormViewerTo()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/functions/renderFormViewerTo): renderFormViewerTo(container, props): Root
- [fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/): Interfaces
- [Interface: FastQrProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/interfaces/FastQrProps): The Fast QR component properties.
- [Variable: fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrComponent): const fastQrComponent: Definer\ = fastQr
- [Variable: fastQrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrComponentsDescriptions): const fastQrComponentsDescriptions: Record\
- [Variable: fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrEnUsComponentsDescriptions): fastQrEnUsComponentsDescriptions: object
- [Variable: fastQrModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrModel): const fastQrModel: Model\
- [googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/): Interfaces
- [Function: toAddress()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/functions/toAddress): toAddress(components): Address
- [Interface: GoogleMapProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/interfaces/GoogleMapProps): Props for the GoogleMap component.
- [Type Alias: Address](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/type-aliases/Address): Address = object
- [Type Alias: MapMarker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/type-aliases/MapMarker): MapMarker = object
- [Variable: googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapComponent): const googleMapComponent: Definer\ = googleMap
- [Variable: googleMapComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapComponentsDescriptions): const googleMapComponentsDescriptions: Record\
- [Variable: googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapEnUsComponentsDescriptions): googleMapEnUsComponentsDescriptions: object
- [Variable: googleMapModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapModel): const googleMapModel: Model\
- [richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/): Interfaces
- [Interface: RichTextEditorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/interfaces/RichTextEditorProps): The Rich text editor component properties.
- [Variable: richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextComponent): const richTextComponent: Definer\ = richTextEditor
- [Variable: richTextEditorComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextEditorComponentsDescriptions): const richTextEditorComponentsDescriptions: Record\
- [Variable: richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextEditorEnUsComponentsDescriptions): richTextEditorEnUsComponentsDescriptions: object
- [Variable: richTextModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextModel): const richTextModel: Model\
- [rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/): Interfaces
- [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader): formEngineRsuiteCssLoader(): Promise\
- [Function: ltrCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/ltrCssLoader): ltrCssLoader(): Promise\
- [Function: RsLocalizationWrapper()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/RsLocalizationWrapper): RsLocalizationWrapper(props): Element
- [Function: rtlCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/rtlCssLoader): rtlCssLoader(): Promise\
- [Interface: RsAutoCompleteProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsAutoCompleteProps): The properties of the RsAutoComplete component.
- [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps): Props for a single breadcrumb item.
- [Interface: RsBreadcrumbProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsBreadcrumbProps): Props for the RsBreadcrumb component.
- [Interface: RsCalendarProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsCalendarProps): Props for the RsCalendar component.
- [Interface: RsCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsCardProps): Props for the RsCard component.
- [Interface: RsContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsContainerProps): Props for the RsContainer component.
- [Interface: RsDatePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsDatePickerProps): Props for the RsDatePicker component.
- [Interface: RsDropdownProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsDropdownProps): Props for the RsDropdown component.
- [Interface: RsErrorMessageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps): The properties of RsErrorMessage component.
- [Interface: RsHeaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsHeaderProps): Props for the RsHeader component.
- [Interface: RsImageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsImageProps): Props for the RsImage component.
- [Interface: RsInputProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsInputProps): Props for the RsInput component.
- [Interface: RsLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsLabelProps): Props for the RsLabel component.
- [Interface: RsLinkProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsLinkProps): Props for the RsLink component.
- [Interface: RsMenuProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsMenuProps): Props for the RsMenu component.
- [Interface: RsModalLayoutProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsModalLayoutProps): Props for the RsModalLayout component.
- [Interface: RsModalProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsModalProps): Props for the RsModal component.
- [Interface: RsNumberFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsNumberFormatProps): Props for the RsNumberFormat component.
- [Interface: RsPatternFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsPatternFormatProps): Props for the RsPatternFormat component.
- [Interface: RsRadioGroupProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsRadioGroupProps): Props for the RsRadioGroup component.
- [Interface: RsSearchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsSearchProps): Props for the RsSearch component.
- [Interface: RsStaticContentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsStaticContentProps): Props for the RsStaticContent component.
- [Interface: RsTabProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTabProps): Props for the RsTab component.
- [Interface: RsTagPickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTagPickerProps): Props for the RsTagPicker component.
- [Interface: RsTextAreaProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTextAreaProps): Props for the RsTextArea component.
- [Interface: RsTimePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTimePickerProps): Props for the RsTimePicker component.
- [Interface: RsTooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTooltipProps): The properties of RsTooltip component.
- [Interface: RsUploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsUploaderProps): Props for the RsUploader component.
- [Interface: RsWizardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsWizardProps): Props for the RsWizard component.
- [Interface: RsWizardStepProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsWizardStepProps): Props for the RsWizardStep component.
- [Type Alias: LoadCallback()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/LoadCallback): LoadCallback = (newData) => void
- [Type Alias: LoadDataHandler()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/LoadDataHandler): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => void
- [Type Alias: MenuItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/MenuItem): MenuItem = object
- [Type Alias: RsTabItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/RsTabItem): RsTabItem = object
- [Variable: builderViewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/builderViewWithCss): const builderViewWithCss: BuilderView
- [Variable: components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/components): const components: BuilderComponent[]
- [Variable: models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/models): const models: Model\[]
- [Variable: rsAutoComplete](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsAutoComplete): const rsAutoComplete: Definer\
- [Variable: rsBreadcrumb](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsBreadcrumb): const rsBreadcrumb: Definer\
- [Variable: rsButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsButton): const rsButton: Definer\
- [Variable: rsCalendar](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsCalendar): const rsCalendar: Definer\
- [Variable: rsCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsCard): const rsCard: Definer\
- [Variable: rsCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsCheckbox): const rsCheckbox: Definer\\>
- [Variable: rsContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsContainer): const rsContainer: Definer\\>
- [Variable: rsDatePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsDatePicker): const rsDatePicker: Definer\
- [Variable: rsDivider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsDivider): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\>
- [Variable: rsDropdown](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsDropdown): const rsDropdown: Definer\
- [Variable: rsErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsErrorMessage): const rsErrorMessage: Definer\
- [Variable: rsHeader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsHeader): const rsHeader: Definer\
- [Variable: rsImage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsImage): const rsImage: Definer\
- [Variable: rsInput](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsInput): const rsInput: Definer\
- [Variable: rsLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsLabel): const rsLabel: Definer\
- [Variable: rsLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsLink): const rsLink: Definer\
- [Variable: rsMenu](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsMenu): const rsMenu: Definer\
- [Variable: rsMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsMessage): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\>
- [Variable: rsModal](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsModal): const rsModal: Definer\
- [Variable: rsModalLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsModalLayout): const rsModalLayout: Definer\
- [Variable: rsNumberFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsNumberFormat): const rsNumberFormat: Definer\
- [Variable: rsPatternFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPatternFormat): const rsPatternFormat: Definer\
- [Variable: rsPlaceholderGraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPlaceholderGraph): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\>
- [Variable: rsPlaceholderGrid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPlaceholderGrid): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\>
- [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPlaceholderParagraph): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\>
- [Variable: rsProgressCircle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsProgressCircle): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\>
- [Variable: rsProgressLine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsProgressLine): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\>
- [Variable: rsRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsRadioGroup): const rsRadioGroup: Definer\
- [Variable: rsSearch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsSearch): const rsSearch: Definer\
- [Variable: rsStaticContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsStaticContent): const rsStaticContent: Definer\
- [Variable: rsTab](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTab): const rsTab: Definer\
- [Variable: rsTagPicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTagPicker): const rsTagPicker: Definer\
- [Variable: rsTextArea](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTextArea): const rsTextArea: Definer\
- [Variable: rsTimePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTimePicker): const rsTimePicker: Definer\
- [Variable: rsToggle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsToggle): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\>
- [Variable: rsTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTooltip): const rsTooltip: Definer\
- [Variable: rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rSuiteComponents): const rSuiteComponents: Definer\[] = []
- [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rSuiteComponentsDescriptions): const rSuiteComponentsDescriptions: Record\
- [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rSuiteEnUsComponentsDescriptions): rSuiteEnUsComponentsDescriptions: object
- [Variable: rsUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsUploader): const rsUploader: Definer\
- [Variable: rsWizard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsWizard): const rsWizard: Definer\
- [Variable: rsWizardStep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsWizardStep): const rsWizardStep: Definer\ & HTMLAttributes\\>
- [Variable: view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/view): const view: View
- [Variable: viewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/viewWithCss): const viewWithCss: View
- [rSuiteTableComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/): Variables
- [Variable: rSuiteTableComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/rSuiteTableComponents): const rSuiteTableComponents: Definer\[] = []
- [Variable: rSuiteTableComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/rSuiteTableComponentsDescriptions): const rSuiteTableComponentsDescriptions: Record\
- [Variable: rSuiteTableEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/rSuiteTableEnUsComponentsDescriptions): rSuiteTableEnUsComponentsDescriptions: object
- [Variable: tableModels](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/tableModels): const tableModels: Model\[]
- [signatureComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/): Interfaces
- [Interface: SignatureProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/interfaces/SignatureProps): The Signature pad properties.
- [Variable: signatureComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureComponent): const signatureComponent: Definer\ = signature
- [Variable: signatureComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureComponentsDescriptions): const signatureComponentsDescriptions: Record\
- [Variable: signatureEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureEnUsComponentsDescriptions): signatureEnUsComponentsDescriptions: object
- [Variable: signatureModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureModel): const signatureModel: Model\
- [Variable: createView()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/variables/createView): const createView: (models) => View = View.create
- [@react-form-builder/viewer-bundle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/): Namespaces
- [Class: ActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/classes/ActionDefinition): Represents the definition of an action.
- [Class: Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/classes/Language): The language to localize the form builder.
- [Function: buildForm()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/functions/buildForm): buildForm(options?): IFormJsonBuilder
- [Function: renderFormViewer()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/functions/renderFormViewer): renderFormViewer(elementId, props): Root
- [Function: renderFormViewerTo()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/functions/renderFormViewerTo): renderFormViewerTo(container, props): Root
- [rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/): Interfaces
- [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader): formEngineRsuiteCssLoader(): Promise\
- [Function: ltrCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/ltrCssLoader): ltrCssLoader(): Promise\
- [Function: RsLocalizationWrapper()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/RsLocalizationWrapper): RsLocalizationWrapper(props): Element
- [Function: rtlCssLoader()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/rtlCssLoader): rtlCssLoader(): Promise\
- [Interface: RsAutoCompleteProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsAutoCompleteProps): The properties of the RsAutoComplete component.
- [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps): Props for a single breadcrumb item.
- [Interface: RsBreadcrumbProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbProps): Props for the RsBreadcrumb component.
- [Interface: RsCalendarProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsCalendarProps): Props for the RsCalendar component.
- [Interface: RsCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsCardProps): Props for the RsCard component.
- [Interface: RsContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsContainerProps): Props for the RsContainer component.
- [Interface: RsDatePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsDatePickerProps): Props for the RsDatePicker component.
- [Interface: RsDropdownProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsDropdownProps): Props for the RsDropdown component.
- [Interface: RsErrorMessageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps): The properties of RsErrorMessage component.
- [Interface: RsHeaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsHeaderProps): Props for the RsHeader component.
- [Interface: RsImageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsImageProps): Props for the RsImage component.
- [Interface: RsInputProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsInputProps): Props for the RsInput component.
- [Interface: RsLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsLabelProps): Props for the RsLabel component.
- [Interface: RsLinkProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsLinkProps): Props for the RsLink component.
- [Interface: RsMenuProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsMenuProps): Props for the RsMenu component.
- [Interface: RsModalLayoutProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsModalLayoutProps): Props for the RsModalLayout component.
- [Interface: RsModalProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsModalProps): Props for the RsModal component.
- [Interface: RsNumberFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsNumberFormatProps): Props for the RsNumberFormat component.
- [Interface: RsPatternFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsPatternFormatProps): Props for the RsPatternFormat component.
- [Interface: RsRadioGroupProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsRadioGroupProps): Props for the RsRadioGroup component.
- [Interface: RsSearchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsSearchProps): Props for the RsSearch component.
- [Interface: RsStaticContentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsStaticContentProps): Props for the RsStaticContent component.
- [Interface: RsTabProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTabProps): Props for the RsTab component.
- [Interface: RsTagPickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTagPickerProps): Props for the RsTagPicker component.
- [Interface: RsTextAreaProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTextAreaProps): Props for the RsTextArea component.
- [Interface: RsTimePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTimePickerProps): Props for the RsTimePicker component.
- [Interface: RsTooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps): The properties of RsTooltip component.
- [Interface: RsUploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsUploaderProps): Props for the RsUploader component.
- [Interface: RsWizardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardProps): Props for the RsWizard component.
- [Interface: RsWizardStepProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardStepProps): Props for the RsWizardStep component.
- [Type Alias: LoadCallback()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/LoadCallback): LoadCallback = (newData) => void
- [Type Alias: LoadDataHandler()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/LoadDataHandler): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => void
- [Type Alias: MenuItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/MenuItem): MenuItem = object
- [Type Alias: RsTabItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/RsTabItem): RsTabItem = object
- [Variable: builderViewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/builderViewWithCss): const builderViewWithCss: BuilderView
- [Variable: components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/components): const components: BuilderComponent[]
- [Variable: models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/models): const models: Model\[]
- [Variable: rsAutoComplete](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsAutoComplete): const rsAutoComplete: Definer\
- [Variable: rsBreadcrumb](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsBreadcrumb): const rsBreadcrumb: Definer\
- [Variable: rsButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsButton): const rsButton: Definer\
- [Variable: rsCalendar](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsCalendar): const rsCalendar: Definer\
- [Variable: rsCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsCard): const rsCard: Definer\
- [Variable: rsCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsCheckbox): const rsCheckbox: Definer\\>
- [Variable: rsContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsContainer): const rsContainer: Definer\\>
- [Variable: rsDatePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsDatePicker): const rsDatePicker: Definer\
- [Variable: rsDivider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsDivider): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\>
- [Variable: rsDropdown](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsDropdown): const rsDropdown: Definer\
- [Variable: rsErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsErrorMessage): const rsErrorMessage: Definer\
- [Variable: rsHeader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsHeader): const rsHeader: Definer\
- [Variable: rsImage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsImage): const rsImage: Definer\
- [Variable: rsInput](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsInput): const rsInput: Definer\
- [Variable: rsLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsLabel): const rsLabel: Definer\
- [Variable: rsLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsLink): const rsLink: Definer\
- [Variable: rsMenu](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsMenu): const rsMenu: Definer\
- [Variable: rsMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsMessage): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\>
- [Variable: rsModal](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsModal): const rsModal: Definer\
- [Variable: rsModalLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsModalLayout): const rsModalLayout: Definer\
- [Variable: rsNumberFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsNumberFormat): const rsNumberFormat: Definer\
- [Variable: rsPatternFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPatternFormat): const rsPatternFormat: Definer\
- [Variable: rsPlaceholderGraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGraph): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\>
- [Variable: rsPlaceholderGrid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGrid): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\>
- [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderParagraph): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\>
- [Variable: rsProgressCircle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsProgressCircle): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\>
- [Variable: rsProgressLine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsProgressLine): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\>
- [Variable: rsRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsRadioGroup): const rsRadioGroup: Definer\
- [Variable: rsSearch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsSearch): const rsSearch: Definer\
- [Variable: rsStaticContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsStaticContent): const rsStaticContent: Definer\
- [Variable: rsTab](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTab): const rsTab: Definer\
- [Variable: rsTagPicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTagPicker): const rsTagPicker: Definer\
- [Variable: rsTextArea](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTextArea): const rsTextArea: Definer\
- [Variable: rsTimePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTimePicker): const rsTimePicker: Definer\
- [Variable: rsToggle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsToggle): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\>
- [Variable: rsTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTooltip): const rsTooltip: Definer\
- [Variable: rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponents): const rSuiteComponents: Definer\[] = []
- [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponentsDescriptions): const rSuiteComponentsDescriptions: Record\
- [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rSuiteEnUsComponentsDescriptions): rSuiteEnUsComponentsDescriptions: object
- [Variable: rsUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsUploader): const rsUploader: Definer\
- [Variable: rsWizard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsWizard): const rsWizard: Definer\
- [Variable: rsWizardStep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsWizardStep): const rsWizardStep: Definer\ & HTMLAttributes\\>
- [Variable: view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/view): const view: View
- [Variable: viewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/viewWithCss): const viewWithCss: View
- [Variable: createView()](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/variables/createView): const createView: (models) => View = View.create

### building-forms-via-code

How to create a form using code.

- [Building forms via code](https://formengine.io/documentation/documentation/building-forms-via-code): How to create a form using code.

### bundle-size-comparison

Comparison of bundle sizes of FormEngine Core, SurveyJS, react-jsonschema-form, Vueform

- [Preface](https://formengine.io/documentation/documentation/bundle-size-comparison): Comparison of bundle sizes of FormEngine Core, SurveyJS, react-jsonschema-form, Vueform

### camunda-integration

Camunda is a comprehensive workflow automation and decision-making platform that provides process management solutions for organizations of

- [Camunda integration](https://formengine.io/documentation/documentation/camunda-integration): Camunda is a comprehensive workflow automation and decision-making platform that provides process management solutions for organizations of

### category

- [FAQ](https://formengine.io/documentation/documentation/category/faq): Drag'n'Drop Form builder frequently asked questions.
- [Guides](https://formengine.io/documentation/documentation/category/guides): Drag'n'Drop Form builder guides.

### components-library

FormEngine supports multiple UI component libraries. The primary libraries available are:

- [Components library](https://formengine.io/documentation/documentation/components-library/): FormEngine supports multiple UI component libraries. The primary libraries available are:
- [Fields components](https://formengine.io/documentation/documentation/components-library/fields-components)
- [AutoComplete](https://formengine.io/documentation/documentation/components-library/fields-components/autocomplete): The AutoComplete component allows you to add an auto-complete field to a form.
- [Calendar](https://formengine.io/documentation/documentation/components-library/fields-components/calendar): The Calendar component enables you to add a calendar to your form.
- [Checkbox](https://formengine.io/documentation/documentation/components-library/fields-components/checkbox): Allows your users to confirm or agree with your provided statement
- [DatePicker](https://formengine.io/documentation/documentation/components-library/fields-components/date-picker): Highly customizable component that enables users to enter and pick dates and times in different formats
- [Dropdown](https://formengine.io/documentation/documentation/components-library/fields-components/dropdown): Dropdown is a component that is used to create a list of predefined choices and options.
- [Input](https://formengine.io/documentation/documentation/components-library/fields-components/input): The Input component is a text input field that allows users to enter and edit text
- [Number format](https://formengine.io/documentation/documentation/components-library/fields-components/number-format): Powerful input formatter that allows you to restrict and format user input to specific numeric or string patterns
- [Pattern format](https://formengine.io/documentation/documentation/components-library/fields-components/pattern-format): Pattern format is used for formatting and displaying numbers and numeric values according to your specified pattern
- [Radio group](https://formengine.io/documentation/documentation/components-library/fields-components/radio-group): Allows users to select one option from a list of choices.
- [Search](https://formengine.io/documentation/documentation/components-library/fields-components/search): Allows users to search for specific information within your specified dataset
- [Tag picker](https://formengine.io/documentation/documentation/components-library/fields-components/tag-picker): Allows users to select one or multiple tags from a predefined list.
- [Text area](https://formengine.io/documentation/documentation/components-library/fields-components/text-area): Multi-line input field that allows users to enter and edit text
- [TimePicker](https://formengine.io/documentation/documentation/components-library/fields-components/time-picker): A component that allows users to enter and select time in various formats.
- [Toggle](https://formengine.io/documentation/documentation/components-library/fields-components/toggle): Switch that allows users to select one of two mutually exclusive options
- [Uploader](https://formengine.io/documentation/documentation/components-library/fields-components/uploader): Used to upload data or attach files to the form
- [Material UI components](https://formengine.io/documentation/documentation/components-library/material-ui/): The list of Material UI components used in the FormEngine library.
- [Box](https://formengine.io/documentation/documentation/components-library/material-ui/box): The Box component is a generic container component for layout and styling with Material UI's styling system
- [Breadcrumbs](https://formengine.io/documentation/documentation/components-library/material-ui/breadcrumbs): The Breadcrumbs component displays a navigation trail for users to track their location within an application
- [Button](https://formengine.io/documentation/documentation/components-library/material-ui/button): The Button component allows users to trigger actions with a single click
- [ButtonGroup](https://formengine.io/documentation/documentation/components-library/material-ui/button-group): The ButtonGroup component groups related buttons together for better visual organization
- [Card](https://formengine.io/documentation/documentation/components-library/material-ui/card): The Card component is a versatile container for displaying content and actions about a single subject
- [Checkbox](https://formengine.io/documentation/documentation/components-library/material-ui/checkbox): The Checkbox component allows users to select one or multiple options from a set
- [CircularProgress](https://formengine.io/documentation/documentation/components-library/material-ui/circular-progress): The CircularProgress component displays a circular loading indicator for indeterminate or determinate progress
- [Container](https://formengine.io/documentation/documentation/components-library/material-ui/container): The Container component provides a responsive container to center and constrain content width
- [Dialog](https://formengine.io/documentation/documentation/components-library/material-ui/dialog): The Dialog component creates modal overlay windows for user interactions, alerts, confirmations, and data entry with Material Design styling
- [Dialog Actions](https://formengine.io/documentation/documentation/components-library/material-ui/dialog-actions): The DialogActions component provides a container for action buttons at the bottom of dialog windows
- [Dialog Content](https://formengine.io/documentation/documentation/components-library/material-ui/dialog-content): The DialogContent component provides a container for the main content area of dialog windows
- [Dialog Content Text](https://formengine.io/documentation/documentation/components-library/material-ui/dialog-content-text): The DialogContentText component provides styled text content for dialog windows with Material Design typography
- [Dialog Layout](https://formengine.io/documentation/documentation/components-library/material-ui/dialog-layout): A preset component that provides a complete dialog structure with title, content text, and action buttons for quick dialog implementation
- [Dialog Title](https://formengine.io/documentation/documentation/components-library/material-ui/dialog-title): The DialogTitle component provides a styled title area for dialog windows with Material Design typography
- [ErrorWrapper](https://formengine.io/documentation/documentation/components-library/material-ui/error-wrapper): The ErrorWrapper component displays error messages and validation feedback for form fields and other components
- [FormControlLabel](https://formengine.io/documentation/documentation/components-library/material-ui/form-control-label): The FormControlLabel component wraps form controls with labels for better accessibility and consistent styling
- [FormLabel](https://formengine.io/documentation/documentation/components-library/material-ui/form-label): The FormLabel component provides labels for form controls with consistent styling and accessibility features
- [LinearProgress](https://formengine.io/documentation/documentation/components-library/material-ui/linear-progress): The LinearProgress component displays a horizontal loading indicator for indeterminate or determinate progress
- [Link](https://formengine.io/documentation/documentation/components-library/material-ui/link): The Link component displays hyperlinks with Material Design styling and accessibility features
- [List](https://formengine.io/documentation/documentation/components-library/material-ui/list): The List component displays a collection of items in a structured, scrollable container
- [ListItem](https://formengine.io/documentation/documentation/components-library/material-ui/list-item): The ListItem component represents a single item within a list, with support for text, icons, avatars, and actions
- [Radio Group](https://formengine.io/documentation/documentation/components-library/material-ui/radio-group): The Radio Group component allows users to select one option from a mutually exclusive set of choices
- [RadioItem](https://formengine.io/documentation/documentation/components-library/material-ui/radio-item): The RadioItem component represents a single radio button option within a radio group with label and value association
- [Select](https://formengine.io/documentation/documentation/components-library/material-ui/select): The Select component is a dropdown menu that allows users to choose one option from a list
- [Stack](https://formengine.io/documentation/documentation/components-library/material-ui/stack): The Stack component manages layout of immediate children along the vertical or horizontal axis with optional spacing and dividers
- [Switch](https://formengine.io/documentation/documentation/components-library/material-ui/switch): The Switch component is a toggle switch that allows users to choose between two mutually exclusive states
- [TextField](https://formengine.io/documentation/documentation/components-library/material-ui/text-field): The TextField component is a versatile text input field that allows users to enter and edit text with Material Design styling
- [Tooltip](https://formengine.io/documentation/documentation/components-library/material-ui/tooltip): The Tooltip component displays informative text when users hover over, focus on, or tap an element
- [Typography](https://formengine.io/documentation/documentation/components-library/material-ui/typography): The Typography component provides consistent text styling and semantic HTML elements
- [Uploader](https://formengine.io/documentation/documentation/components-library/material-ui/uploader): The Uploader component allows users to upload files with a Material UI styled interface
- [React Suite components](https://formengine.io/documentation/documentation/components-library/rsuite-components): The list of React Suite components used in the FormEngine library.
- [Static components](https://formengine.io/documentation/documentation/components-library/static-components)
- [Button](https://formengine.io/documentation/documentation/components-library/static-components/button): Clickable element that allows users to perform an action or trigger an event
- [Divider](https://formengine.io/documentation/documentation/components-library/static-components/divider): Divider are used to group content horizontally or vertically
- [Error message](https://formengine.io/documentation/documentation/components-library/static-components/error-message): Used to display an error message to the user, typically in response to form validation error
- [Header](https://formengine.io/documentation/documentation/components-library/static-components/header): Text element that displays a title or heading
- [Image](https://formengine.io/documentation/documentation/components-library/static-components/image): Enables to upload and customize images
- [Label](https://formengine.io/documentation/documentation/components-library/static-components/label): Used to provide descriptive text or captions
- [Link](https://formengine.io/documentation/documentation/components-library/static-components/link): Creates a hyperlink to another webpage, email address, or file
- [Menu](https://formengine.io/documentation/documentation/components-library/static-components/menu): Navigation menu that provides a list of links to different sections
- [Message](https://formengine.io/documentation/documentation/components-library/static-components/message): Displays a message or notification to the user
- [Placeholder graph](https://formengine.io/documentation/documentation/components-library/static-components/placeholder-graph): Shows the graph placeholder before loading the component
- [Placeholder grid](https://formengine.io/documentation/documentation/components-library/static-components/placeholder-grid): Shows the grid placeholder before loading the component
- [Placeholder paragraph](https://formengine.io/documentation/documentation/components-library/static-components/placeholder-paragraph): Shows the paragraph placeholder before loading the component
- [Progress Circle](https://formengine.io/documentation/documentation/components-library/static-components/progress-circle): Represents a circular progress indicator for users
- [Progress Line](https://formengine.io/documentation/documentation/components-library/static-components/progress-line): Provides a linear progress indicator for users
- [Static Content](https://formengine.io/documentation/documentation/components-library/static-components/static-content): Displays static text content within an HTML span tag
- [Tooltip](https://formengine.io/documentation/documentation/components-library/static-components/tooltip): Text box that appears when users interact with your component
- [Structure components](https://formengine.io/documentation/documentation/components-library/structure-components)
- [Breadcrumb](https://formengine.io/documentation/documentation/components-library/structure-components/breadcrumb): Displays a hierarchical trail of links
- [Card](https://formengine.io/documentation/documentation/components-library/structure-components/card): Creates organized layout for your components
- [Container](https://formengine.io/documentation/documentation/components-library/structure-components/container): Wraps other components, providing a way to group and organize content
- [Modal](https://formengine.io/documentation/documentation/components-library/structure-components/modal): Displays a modal window
- [Modal layout](https://formengine.io/documentation/documentation/components-library/structure-components/modal-layout): Provides an appearance for a modal window
- [Repeater](https://formengine.io/documentation/documentation/components-library/structure-components/repeater): Displays a repeating set of components
- [RsModal](https://formengine.io/documentation/documentation/components-library/structure-components/rs-modal): Displays a React Suite modal window
- [Tab](https://formengine.io/documentation/documentation/components-library/structure-components/tab): Allows users to switch between different views or panels
- [Wizard](https://formengine.io/documentation/documentation/components-library/structure-components/wizard): Allows users to create multistep forms or wizards.
- [Wizard step](https://formengine.io/documentation/documentation/components-library/structure-components/wizard-step): Allows users to add steps to the Wizard component.
- [Templates components](https://formengine.io/documentation/documentation/components-library/templates-components)
- [Embedded form](https://formengine.io/documentation/documentation/components-library/templates-components/embedded-form): Displays a nested form
- [Slot](https://formengine.io/documentation/documentation/components-library/templates-components/slot): Used to display the components of the parent form in the child form

### components-with-multiple-children

How to define components with multiple children components.

- [Components with multiple children](https://formengine.io/documentation/documentation/components-with-multiple-children): How to define components with multiple children components.

### dynamic-dropdown-population

How to fill dropdown dynamically.

- [Dynamic dropdown population](https://formengine.io/documentation/documentation/dynamic-dropdown-population): How to fill dropdown dynamically.

### enabling-google-maps-autocomplete

Guide to setting up Google Maps with autocomplete functionality.

- [Google Maps address autocomplete](https://formengine.io/documentation/documentation/enabling-google-maps-autocomplete): Guide to setting up Google Maps with autocomplete functionality.

### form-data

FormEngine provides a flexible, reactive architecture for working with form data, allowing integration with other apps and

- [Working with form data and role of initialData](https://formengine.io/documentation/documentation/form-data): FormEngine provides a flexible, reactive architecture for working with form data, allowing integration with other apps and

### formengine-core

FormEngine Core - The easiest way to create beautiful forms with Material UI components

- [FormEngine Core](https://formengine.io/documentation/documentation/formengine-core): FormEngine Core - The easiest way to create beautiful forms with Material UI components
- [Actions and Events](https://formengine.io/documentation/documentation/formengine-core/actions-and-events): Actions and events are the core building blocks for creating interactive forms in FormEngine Core. They allow you to define what happens
- [Adaptive Layout](https://formengine.io/documentation/documentation/formengine-core/adaptive-layout): Learn how FormEngine Core automatically adapts forms to different screen sizes with device-specific styling and view modes
- [Computed Properties](https://formengine.io/documentation/documentation/formengine-core/computed-properties): Define component properties that recalculate automatically based on form state.
- [Conditional rendering](https://formengine.io/documentation/documentation/formengine-core/conditional-rendering): Show or hide components with renderWhen based on current form state.
- [Custom Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/): Custom components are the heart of FormEngine Core's extensibility. They allow you to create reusable UI elements that integrate seamlessly
- [Advanced Component Patterns](https://formengine.io/documentation/documentation/formengine-core/custom-components/advanced-patterns): This guide covers advanced patterns for creating sophisticated custom components that handle complex scenarios, including composite
- [Components with Events](https://formengine.io/documentation/documentation/formengine-core/custom-components/component-with-events): Events enable components to respond to user interactions and communicate with other parts of your application. This guide covers creating
- [Container Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/container-component): Container components are special components in FormEngine Core that can hold and render child components. Unlike regular components that
- [Custom Component Wrapper](https://formengine.io/documentation/documentation/formengine-core/custom-components/custom-component-wrapper): Overview
- [Custom Error Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/custom-error-component): Custom error components allow you to create tailored error message displays that match your application's design system while maintaining
- [Custom Modal Component](https://formengine.io/documentation/documentation/formengine-core/custom-components/custom-modal-component): Modal components in FormEngine Core are special UI elements that display content in a dialog window on top of the current form. Unlike
- [Custom Tooltip Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/custom-tooltip-component): Tooltip components provide contextual help and information to users when they interact with form elements. In FormEngine Core, you can
- [Disabled and Read-Only Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/disabled-and-read-only): FormEngine Core provides a powerful mechanism for handling disabled and read-only states in custom components. Using
- [Functional Properties](https://formengine.io/documentation/documentation/formengine-core/custom-components/functional-properties): Functional properties allow you to define component properties that execute custom JavaScript functions at runtime to transform or compute
- [Getting Started with Custom Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/getting-started): This guide will help you create your first custom component for FormEngine Core. We'll start with a simple alert component and gradually
- [One-Way Data Binding](https://formengine.io/documentation/documentation/formengine-core/custom-components/one-way-data-binding): While valued components provide powerful two-way data binding, there are scenarios where you only need to display data without allowing user
- [Required Property](https://formengine.io/documentation/documentation/formengine-core/custom-components/required-property): The required property in FormEngine Core is a special boolean property that
- [Simple Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/simple-components): Simple components are display-only components that don't interact with form data. They're perfect for presenting information, creating
- [Styling Custom Components](https://formengine.io/documentation/documentation/formengine-core/custom-components/styling-custom-components): Styling is a crucial aspect of creating visually appealing and consistent custom components in FormEngine Core. This guide covers various
- [Valued Components (Data Binding)](https://formengine.io/documentation/documentation/formengine-core/custom-components/valued-components): Valued components are interactive components that can read from and write to form data. They are the backbone of interactive forms, enabling
- [Disabled and Read-Only Components](https://formengine.io/documentation/documentation/formengine-core/disabled-and-read-only): Many component libraries expose disabled and readOnly flags. disabled usually blocks interaction, while readOnly allows viewing
- [Embedded forms](https://formengine.io/documentation/documentation/formengine-core/embedded-forms): Nest forms inside other forms using the EmbeddedForm component and the getForm function.
- [Form JSON](https://formengine.io/documentation/documentation/formengine-core/forms-json): Understand the shared structure of FormEngine form JSON and how component sets extend it.
- [Handling Form Data in FormViewer](https://formengine.io/documentation/documentation/formengine-core/handling-form-data): Complete guide to working with form data in FormViewer - from basic data binding to advanced data manipulation
- [HTML attributes](https://formengine.io/documentation/documentation/formengine-core/html-attributes): Add custom HTML attributes to components for testing, accessibility, and integration.
- [Installation](https://formengine.io/documentation/documentation/formengine-core/installation): Get FormEngine Core up and running in your React project in under 5 minutes with our simple installation guide
- [JSON schema for the form](https://formengine.io/documentation/documentation/formengine-core/json-schema)
- [Localization and Internationalization](https://formengine.io/documentation/documentation/formengine-core/localization): FormEngine Core provides comprehensive support for localization and internationalization, allowing you to create forms that can be displayed
- [Modal](https://formengine.io/documentation/documentation/formengine-core/modal)
- [Rendering Forms](https://formengine.io/documentation/documentation/formengine-core/rendering-forms): FormEngine Core provides a flexible and powerful system for rendering forms defined in JSON format. This document covers the fundamentals of
- [Styling Components and Forms](https://formengine.io/documentation/documentation/formengine-core/styling-components-and-forms): Learn how to style forms and components in FormEngine Core using CSS, JSON, and responsive design techniques
- [Tooltip](https://formengine.io/documentation/documentation/formengine-core/tooltip): Tooltips let you attach contextual help to form fields without taking up layout space. In FormEngine Core, tooltips are rendered by wrapping
- [User defined properties](https://formengine.io/documentation/documentation/formengine-core/user-defined-properties): Override component properties at runtime using userDefinedProps and setUserDefinedProps.
- [Validation in FormEngine Core](https://formengine.io/documentation/documentation/formengine-core/validation): Comprehensive guide to form validation in FormEngine Core

### formengine-designer

FormEngine Designer, React drag and drop form builder library

- [FormEngine Designer](https://formengine.io/documentation/documentation/formengine-designer): FormEngine Designer, React drag and drop form builder library
- [Components](https://formengine.io/documentation/documentation/formengine-designer/components): Components of the FormEngine Designer
- [Google Map](https://formengine.io/documentation/documentation/formengine-designer/components/google-map): The Google Map component enables you to add an interactive map with customizable markers and controls.
- [QR code](https://formengine.io/documentation/documentation/formengine-designer/components/qr-code): Displays QR-code with or without a picture inside it
- [Rich text editor](https://formengine.io/documentation/documentation/formengine-designer/components/rich-text-editor): Powerful text editor.
- [Signature](https://formengine.io/documentation/documentation/formengine-designer/components/signature): A field that allows users to create and capture their handwritten signatures digitally.
- [Table / Data grid](https://formengine.io/documentation/documentation/formengine-designer/components/table): A table displays rows of data
- [Access to external API from Form Designer](https://formengine.io/documentation/documentation/formengine-designer/faq/external-api-access): You can access the desired API via custom actions, which are called on a specific
- [Getting JSON form in React component](https://formengine.io/documentation/documentation/formengine-designer/faq/getting-form-json): Getting form JSON.
- [Storing user-defined data](https://formengine.io/documentation/documentation/formengine-designer/faq/storing-user-defined-data): Each component that implements IFormData can maintain a user-defined data
- [Theme manipulation](https://formengine.io/documentation/documentation/formengine-designer/faq/theme-manipulation): How to set a designer theme (light, dark, or system theme).
- [Using Designer and rsuite components in React 19](https://formengine.io/documentation/documentation/formengine-designer/faq/using-designer-and-rsuite-components-in-react-19): How to use Designer and rsuite components in React 19
- [Actions](https://formengine.io/documentation/documentation/formengine-designer/features/actions): Overview
- [Adaptive layout](https://formengine.io/documentation/documentation/formengine-designer/features/adaptive-layout): Form Builder allows you to set different styles for different layouts. In the "For device" drop-down menu on the "Style" tab, you
- [Component styling](https://formengine.io/documentation/documentation/formengine-designer/features/component-styling): Overview
- [Computed properties](https://formengine.io/documentation/documentation/formengine-designer/features/computed-properties): When designing a form in the designer, you can set the values of the component properties in the right pane. Opposite the component
- [Conditional rendering](https://formengine.io/documentation/documentation/formengine-designer/features/conditional-rendering): Overview
- [Custom components](https://formengine.io/documentation/documentation/formengine-designer/features/custom-components): Overview
- [Designer customization](https://formengine.io/documentation/documentation/formengine-designer/features/designer-customization): Customizing the FormBuilder interface
- [Designer localization](https://formengine.io/documentation/documentation/formengine-designer/features/designer-localization): Using custom languages in Designer can greatly enhance your project by allowing you to target a specific audience or customize the user
- [Disabled and read-only properties](https://formengine.io/documentation/documentation/formengine-designer/features/disabled-and-read-only): How to make a form or part of it disabled or read-only
- [Form storage](https://formengine.io/documentation/documentation/formengine-designer/features/form-storage): By default, the designer does not use external form stores. In this mode you can create forms, export and import forms to JSON files.
- [Form's JSON](https://formengine.io/documentation/documentation/formengine-designer/features/forms-json): Each form created in the form designer is JSON. With the designer, you can export a form to JSON, and you can import a form from JSON.
- [Localization](https://formengine.io/documentation/documentation/formengine-designer/features/localization): Overview
- [Modal components](https://formengine.io/documentation/documentation/formengine-designer/features/modal-components): A modal component is a component that can display information in a modal window/dialog box on top of a form. Most popular component
- [Nested components](https://formengine.io/documentation/documentation/formengine-designer/features/nested-components): Form Builder supports nested components out of the box. There are two types of nested components:
- [Preset components](https://formengine.io/documentation/documentation/formengine-designer/features/presets-components): Create a preset component in Designer
- [User defined properties](https://formengine.io/documentation/documentation/formengine-designer/features/user-defined-properties): How to override the properties of a component in runtime.
- [Using tabs](https://formengine.io/documentation/documentation/formengine-designer/features/using-tabs): Imagine you have a component that displays tabs. As an example, let's use the Nav component from
- [Validation](https://formengine.io/documentation/documentation/formengine-designer/features/validation): Overview
- [Getting started](https://formengine.io/documentation/documentation/formengine-designer/getting-started): Read articles about using FormEngine.
- [Installation](https://formengine.io/documentation/documentation/formengine-designer/getting-started/installation): Installing the Designer and Viewer packages of FormEngine.
- [Overview](https://formengine.io/documentation/documentation/formengine-designer/getting-started/overview): Overview of FormEngine's NPM packages.
- [Usage](https://formengine.io/documentation/documentation/formengine-designer/getting-started/usage): Examples of Designer and Viewer usage.
- [License key](https://formengine.io/documentation/documentation/formengine-designer/license-key): Contact our sales department to obtain a licence key.

### formik-integration

Introduction to FormEngine

- [Formik integration](https://formengine.io/documentation/documentation/formik-integration): Introduction to FormEngine

### integration-with-electron

How to run FormEngine in Electron and connect the Monaco editor locally, without CDN.

- [Integration with Electron](https://formengine.io/documentation/documentation/integration-with-electron): How to run FormEngine in Electron and connect the Monaco editor locally, without CDN.

### linking-dropdowns

Describes how to link dropdown components.

- [Linking dropdown components](https://formengine.io/documentation/documentation/linking-dropdowns): Describes how to link dropdown components.

### release-notes

The official release notes detailing updates, new features, bug fixes, and version changes for the FormEngine platform.

- [Release notes](https://formengine.io/documentation/documentation/release-notes/): The official release notes detailing updates, new features, bug fixes, and version changes for the FormEngine platform.
- [FormEngine 0.0.13](https://formengine.io/documentation/documentation/release-notes/0.0.13): FormEngine 0.0.13 release notes
- [FormEngine 0.0.14](https://formengine.io/documentation/documentation/release-notes/0.0.14): FormEngine 0.0.14 release notes
- [FormEngine 1.0.0](https://formengine.io/documentation/documentation/release-notes/1.0.0): FormEngine 1.0.0 release notes
- [FormEngine 1.0.1](https://formengine.io/documentation/documentation/release-notes/1.0.1): FormEngine 1.0.1 release notes
- [FormEngine 1.0.2](https://formengine.io/documentation/documentation/release-notes/1.0.2): FormEngine 1.0.2 release notes
- [FormEngine 1.0.3](https://formengine.io/documentation/documentation/release-notes/1.0.3): FormEngine 1.0.3 release notes
- [FormEngine 1.0.4](https://formengine.io/documentation/documentation/release-notes/1.0.4): FormEngine 1.0.4 release notes
- [FormEngine 1.0.5](https://formengine.io/documentation/documentation/release-notes/1.0.5): FormEngine 1.0.5 release notes
- [FormEngine 1.0.6](https://formengine.io/documentation/documentation/release-notes/1.0.6): FormEngine 1.0.6 release notes
- [FormEngine 1.0.7](https://formengine.io/documentation/documentation/release-notes/1.0.7): FormEngine 1.0.7 release notes
- [FormEngine 1.0.8](https://formengine.io/documentation/documentation/release-notes/1.0.8): FormEngine 1.0.8 release notes
- [FormEngine 1.0.9](https://formengine.io/documentation/documentation/release-notes/1.0.9): FormEngine 1.0.9 release notes
- [FormEngine 1.1.0](https://formengine.io/documentation/documentation/release-notes/1.1.0): FormEngine 1.1.0 release notes
- [FormEngine 1.10.0](https://formengine.io/documentation/documentation/release-notes/1.10.0): FormEngine 1.10.0 release notes
- [FormEngine 1.11.0](https://formengine.io/documentation/documentation/release-notes/1.11.0): FormEngine 1.11.0 release notes
- [FormEngine 1.12.0](https://formengine.io/documentation/documentation/release-notes/1.12.0): FormEngine 1.12.0 release notes
- [FormEngine 1.13.0](https://formengine.io/documentation/documentation/release-notes/1.13.0): FormEngine 1.13.0 release notes
- [FormEngine 1.14.0](https://formengine.io/documentation/documentation/release-notes/1.14.0): FormEngine 1.14.0 release notes
- [FormEngine 1.14.1](https://formengine.io/documentation/documentation/release-notes/1.14.1): FormEngine 1.14.1 release notes
- [FormEngine 1.2.0](https://formengine.io/documentation/documentation/release-notes/1.2.0): FormEngine 1.2.0 release notes
- [FormEngine 1.3.0](https://formengine.io/documentation/documentation/release-notes/1.3.0): FormEngine 1.3.0 release notes
- [FormEngine 1.3.1](https://formengine.io/documentation/documentation/release-notes/1.3.1): FormEngine 1.3.1 release notes
- [FormEngine 1.4.0](https://formengine.io/documentation/documentation/release-notes/1.4.0): FormEngine 1.4.0 release notes
- [FormEngine 1.5.0](https://formengine.io/documentation/documentation/release-notes/1.5.0): FormEngine 1.5.0 release notes
- [FormEngine 1.5.1](https://formengine.io/documentation/documentation/release-notes/1.5.1): FormEngine 1.5.1 release notes
- [FormEngine 1.5.2](https://formengine.io/documentation/documentation/release-notes/1.5.2): FormEngine 1.5.2 release notes
- [FormEngine 1.6.0](https://formengine.io/documentation/documentation/release-notes/1.6.0): FormEngine 1.6.0 release notes
- [FormEngine 1.7.0](https://formengine.io/documentation/documentation/release-notes/1.7.0): FormEngine 1.7.0 release notes
- [FormEngine 1.8.0](https://formengine.io/documentation/documentation/release-notes/1.8.0): FormEngine 1.8.0 release notes
- [FormEngine 1.9.0](https://formengine.io/documentation/documentation/release-notes/1.9.0): FormEngine 1.9.0 release notes
- [FormEngine 2.0.0](https://formengine.io/documentation/documentation/release-notes/2.0.0): FormEngine 2.0.0 release notes
- [FormEngine 2.1.0](https://formengine.io/documentation/documentation/release-notes/2.1.0): FormEngine 2.1.0 release notes
- [FormEngine 2.2.0](https://formengine.io/documentation/documentation/release-notes/2.2.0): FormEngine 2.2.0 release notes
- [FormEngine 2.3.0](https://formengine.io/documentation/documentation/release-notes/2.3.0): FormEngine 2.3.0 release notes
- [FormEngine 2.4.0](https://formengine.io/documentation/documentation/release-notes/2.4.0): FormEngine 2.4.0 release notes
- [FormEngine 3.0.0](https://formengine.io/documentation/documentation/release-notes/3.0.0): FormEngine 3.0.0 release notes
- [FormEngine 3.0.1](https://formengine.io/documentation/documentation/release-notes/3.0.1): FormEngine 3.0.1 release notes
- [FormEngine 3.0.2](https://formengine.io/documentation/documentation/release-notes/3.0.2): FormEngine 3.0.2 release notes
- [FormEngine 3.1.0](https://formengine.io/documentation/documentation/release-notes/3.1.0): FormEngine 3.1.0 release notes
- [FormEngine 3.2.0](https://formengine.io/documentation/documentation/release-notes/3.2.0): FormEngine 3.2.0 release notes
- [FormEngine 3.3.0](https://formengine.io/documentation/documentation/release-notes/3.3.0): FormEngine 3.3.0 release notes
- [FormEngine 3.4.0](https://formengine.io/documentation/documentation/release-notes/3.4.0): FormEngine 3.4.0 release notes
- [FormEngine 3.4.1](https://formengine.io/documentation/documentation/release-notes/3.4.1): FormEngine 3.4.1 release notes
- [FormEngine 3.5.0](https://formengine.io/documentation/documentation/release-notes/3.5.0): FormEngine 3.5.0 release notes
- [FormEngine 3.6.0](https://formengine.io/documentation/documentation/release-notes/3.6.0): FormEngine 3.6.0 release notes
- [FormEngine 4.0.0](https://formengine.io/documentation/documentation/release-notes/4.0.0): FormEngine 4.0.0 release notes
- [FormEngine 4.1.0](https://formengine.io/documentation/documentation/release-notes/4.1.0): FormEngine 4.1.0 release notes
- [FormEngine 4.2.0](https://formengine.io/documentation/documentation/release-notes/4.2.0): FormEngine 4.2.0 release notes
- [FormEngine 4.3.0](https://formengine.io/documentation/documentation/release-notes/4.3.0): FormEngine 4.3.0 release notes
- [FormEngine 4.3.1](https://formengine.io/documentation/documentation/release-notes/4.3.1): FormEngine 4.3.1 release notes
- [FormEngine 4.3.2](https://formengine.io/documentation/documentation/release-notes/4.3.2): FormEngine 4.3.2 release notes
- [FormEngine 5.0.0](https://formengine.io/documentation/documentation/release-notes/5.0.0): FormEngine 5.0.0 release notes
- [FormEngine 5.0.1](https://formengine.io/documentation/documentation/release-notes/5.0.1): FormEngine 5.0.1 release notes
- [FormEngine 5.1.0](https://formengine.io/documentation/documentation/release-notes/5.1.0): FormEngine 5.1.0 release notes
- [FormEngine 5.2.0](https://formengine.io/documentation/documentation/release-notes/5.2.0): FormEngine 5.2.0 release notes
- [FormEngine 6.0.0](https://formengine.io/documentation/documentation/release-notes/6.0.0): FormEngine 6.0.0 release notes
- [FormEngine 6.1.0](https://formengine.io/documentation/documentation/release-notes/6.1.0): FormEngine 6.1.0 release notes
- [FormEngine 6.2.0](https://formengine.io/documentation/documentation/release-notes/6.2.0): FormEngine 6.2.0 release notes
- [FormEngine 6.2.1](https://formengine.io/documentation/documentation/release-notes/6.2.1): FormEngine 6.2.1 release notes
- [FormEngine 7.0.0](https://formengine.io/documentation/documentation/release-notes/7.0.0): FormEngine 7.0.0 release notes
- [FormEngine 7.1.0](https://formengine.io/documentation/documentation/release-notes/7.1.0): FormEngine 7.1.0 release notes
- [FormEngine 7.10.0](https://formengine.io/documentation/documentation/release-notes/7.10.0): Material UI library integration, documentation, and security updates
- [FormEngine 7.11.0](https://formengine.io/documentation/documentation/release-notes/7.11.0): Core package cleanup, MUI improvements, dependency updates, and documentation
- [FormEngine 7.2.0](https://formengine.io/documentation/documentation/release-notes/7.2.0): FormEngine 7.2.0 release notes
- [FormEngine 7.3.0](https://formengine.io/documentation/documentation/release-notes/7.3.0): FormEngine 7.3.0 release notes
- [FormEngine 7.4.0](https://formengine.io/documentation/documentation/release-notes/7.4.0): FormEngine 7.4.0 release notes
- [FormEngine 7.5.0](https://formengine.io/documentation/documentation/release-notes/7.5.0): FormEngine 7.5.0 release notes
- [FormEngine 7.6.0](https://formengine.io/documentation/documentation/release-notes/7.6.0): FormEngine 7.6.0 release notes
- [FormEngine 7.7.0](https://formengine.io/documentation/documentation/release-notes/7.7.0): FormEngine 7.7.0 release notes
- [FormEngine 7.8.0](https://formengine.io/documentation/documentation/release-notes/7.8.0): FormEngine 7.8.0 release notes
- [FormEngine 7.9.0](https://formengine.io/documentation/documentation/release-notes/7.9.0): FormEngine 7.9.0 release notes

### roadmap

On this page you can see what tasks are planned to improve FormEngine. As well as tasks that may be done, but are not yet planned.

- [Roadmap](https://formengine.io/documentation/documentation/roadmap): On this page you can see what tasks are planned to improve FormEngine. As well as tasks that may be done, but are not yet planned.

### styling-multiple-components

Showcases how to style multiple components using CSS.

- [Styling multiple components](https://formengine.io/documentation/documentation/styling-multiple-components): Showcases how to style multiple components using CSS.

### support

Do you need help, found a bug or have an idea?

- [Support](https://formengine.io/documentation/documentation/support): Do you need help, found a bug or have an idea?

### tracking-form-changes

Detecting and tracking changes to data that is submitted to your form can be a crucial aspect of your form management. To detect changes to

- [Tracking form changes](https://formengine.io/documentation/documentation/tracking-form-changes): Detecting and tracking changes to data that is submitted to your form can be a crucial aspect of your form management. To detect changes to

### updating-rsuite

To update the RSuite library in Optimajet’s Designer or Components RSuite, you need to gain access to the source code.

- [Updating RSuite library](https://formengine.io/documentation/documentation/updating-rsuite): To update the RSuite library in Optimajet’s Designer or Components RSuite, you need to gain access to the source code.

### usage-with-nextjs

The FormEngine is fully compatible with the latest versions of the Next.js.

- [Usage with Next.js](https://formengine.io/documentation/documentation/usage-with-nextjs): The FormEngine is fully compatible with the latest versions of the Next.js.

### usage-with-remix

The FormEngine is fully compatible with the latest versions of the Remix.

- [Usage with Remix](https://formengine.io/documentation/documentation/usage-with-remix): The FormEngine is fully compatible with the latest versions of the Remix.

### using-repeater

Learn how to use the Repeater component in your project.

- [Using Repeater](https://formengine.io/documentation/documentation/using-repeater): Learn how to use the Repeater component in your project.

### writing-values-via-actions

How to manipulate values using actions and computed properties.

- [Writing values via actions and computed properties](https://formengine.io/documentation/documentation/writing-values-via-actions): How to manipulate values using actions and computed properties.


---

# Full Documentation Content

[Skip to main content](#__docusaurus_skipToContent_fallback)

[Introducing Workflow Engine, try for FREE workflowengine.io.](https://workflowengine.io/documentation?utm_source=formengine\&utm_medium=topbanner)

[![FormBuilder Logo](/documentation/img/logo.svg)![FormBuilder Logo](/documentation/img/logo_dark.svg)](https://formengine.io/)

[Demo](https://demo.formengine.io/)[Build Form with AI](https://formengine.io/ai-form-builder/)

Search

# Search the documentation

Contacts

* <sales@optimajet.com>

More

* [GitHub](https://github.com/optimajet/formengine)
* [Form Builder Demo](https://demo.formengine.io/)

Products

* [Workflow Engine](https://workflowengine.io)
* [Workflow Server](https://workflowserver.io)

LLMs.txt

* [llms.txt](https://formengine.io/documentation/llms.txt)
* [llms-full.txt](https://formengine.io/documentation/llms-full.txt)

[![OptimaJet Logo](/documentation/img/optimajet-logo.png)![OptimaJet Logo](/documentation/img/optimajet-logo.png)](https://optimajet.com)

Copyright © 2026 Optimajet Limited. All rights reserved.


---

# Adding WASM component

info

You can find the ready-to-connect component in the [@react-form-builder/components-fast-qr](https://www.npmjs.com/package/@react-form-builder/components-fast-qr) NPM package. You can find information on connecting the component in [this section](https://formengine.io/documentation/documentation/formengine-designer/components/qr-code).

## Overview[​](#overview "Direct link to Overview")

[WebAssembly](https://developer.mozilla.org/en-US/docs/WebAssembly) is a popular technology that is becoming more and more popular on the Internet. Let's see how you can connect a WASM (WebAssembly) component to FormEngine.

Currently, WASM components use JavaScript helper code to work with the DOM. So we will take a component that already has this code.

In this article we will connect a component that generates a QR code from the [fast\_qr](https://www.npmjs.com/package/fast_qr) library. The author of the library claims that it is a very fast generator. The library is written in [Rust](https://www.rust-lang.org/), compiled in WASM, and has TypeScript type definitions. A great set of technologies. Well, let's get started!

## Bootstrapping application[​](#bootstrapping-application "Direct link to Bootstrapping application")

Let's create a React application, we will use [Vite](https://vitejs.dev/), open the console and run the following commands:

```
npm create vite@latest my-react-app -- --template react-ts
cd my-react-app
npm install
npm run dev
```

OK, now stop the application and install the FormEngine dependencies (see this [article](https://formengine.io/documentation/installation) for details):

```
npm install @react-form-builder/core @react-form-builder/designer @react-form-builder/components-rsuite
```

Let's remove the default styles from `src/main.tsx`, your `main.tsx` will look like this:

src/main.tsx

```
import React from 'react'
import ReactDOM from 'react-dom/client'
import App from './App.tsx'

ReactDOM.createRoot(document.getElementById('root')!).render(
  <React.StrictMode>
    <App/>
  </React.StrictMode>,
)
```

Replace the contents of the `src/App.tsx` file with the following:

src/App.tsx

```
import {rSuiteComponents} from '@react-form-builder/components-rsuite'
import {BuilderView, FormBuilder} from '@react-form-builder/designer'

const components = rSuiteComponents.map(c => c.build())
const builderView = new BuilderView(components)

function App() {
  return <FormBuilder view={builderView}/>
}

export default App
```

Basically the application is ready, you can run it using the `npm run dev` command. In the browser you will see a ready window with the designer:

![WASM component](/documentation/assets/images/wasm-component-01-99a1857f26670711b3d206e42c15c071.png)

## Adding QR code component[​](#adding-qr-code-component "Direct link to Adding QR code component")

First we need to install the `fast_qr` library as a dependency:

```
npm install fast_qr
```

Second, we need to understand how the component should be used. GitHub has the following example in [description](https://github.com/erwanvivien/fast_qr?tab=readme-ov-file#javascript--typescript):

```
/// Once `init` is called, `qr_svg` can be called any number of times
import init, {qr_svg, SvgOptions, Shape} from '/pkg/fast_qr.js'

const options = new SvgOptions()
  .margin(4)
  .shape(Shape.Square)
  .image("")  // Can be a URL or a base64 encoded image
  .background_color("#b8a4e5")
  .module_color("#ffffff");

// Using then / catch:
init()
  .then(() => {
    for (let i = 0; i < 10; i++) {
      const svg = qr_svg("https://fast-qr.com", options);
      console.log(svg);
    }
  })
  .catch(console.error);

// Or using modern async await:
await init();
for (let i = 0; i < 10; i++) {
  const svg = qr_svg("https://fast-qr.com", options);
  console.log(svg);
}
```

It looks simple and straightforward. First you need to call the `init` function, and then you can call the `qr_svg` function, which will return a line containing the SVG with the QR code. Let's make a React component that encapsulates this logic. Create a file `src/QrCode.tsx` with the following content:

src/QrCode.tsx

```
import init, {qr_svg, Shape, SvgOptions} from 'fast_qr'
import {RefObject, useEffect, useRef} from 'react'
import {define} from '@react-form-builder/core'

export interface QrCodeProps {
  /**
   * The QR code width.
   */
  width?: number

  /**
   * The CSS class name.
   */
  className?: string
}

export const QrCode = (props: QrCodeProps) => {
  const ref = useRef<HTMLDivElement>(null)

  useEffect(() => {
    renderQr(ref).catch(console.error)
  }, [])

  return <div className={props.className} style={{width: props.width}} ref={ref}></div>
}

async function renderQr(ref: RefObject<HTMLDivElement>) {
  await init()

  if (!ref.current) return

  const options = new SvgOptions()
    .margin(4)
    .shape(Shape.Square)
    .image("")  // Can be a URL or a base64 encoded image
    .background_color("#b8a4e5")
    .module_color("#ffffff")

  ref.current.innerHTML = qr_svg("https://fast-qr.com", options)
}

export const qrCode = define(QrCode, 'QrCode')
  .name('QR code')
  .category('static')
```

So, we have defined the component properties as the `QrCodeProps` interface. We also defined the React functional component `QrCode` that displays `div`. The imperative logic is defined in the `renderQr` function - here the `init` method is called, and if we already have a reference to the rendered `div`, then the created SVG with QR code is installed via the `innerHTML` property. At the end, we defined a constant `qrCode` with the description of the component to connect it to the list of components.

It's time to add the component and run the application. Modify the `src/App.tsx` file as shown in the example below:

src/App.tsx

```
import {rSuiteComponents} from '@react-form-builder/components-rsuite'
import {BuilderView, FormBuilder} from '@react-form-builder/designer'
import {qrCode} from './QrCode'

const components = rSuiteComponents.map(c => c.build())
const builderView = new BuilderView([...components, qrCode.build()])

function App() {
  return <FormBuilder view={builderView}/>
}

export default App
```

Run the application with the `npm run dev` command, open the browser, you should see that the QR code component is in the left pane:

![WASM component](/documentation/assets/images/wasm-component-02-4352f95fd49610e2d8b454950b50202d.png)

Great, now drag and drop the QR code component into the center panel:

![WASM component](/documentation/assets/images/wasm-component-03-49584a8c97d5aa5279d2665d1b321cee.png)

Wait, what's that blue line, and where's our generated QR code? Well, the Frontend is dark and full of terrors. Just kidding!

If you open the browser console, you will see an error there:

![WASM component](/documentation/assets/images/wasm-component-04-451b6d541d446c0daa60be0913fa4e59.png)

Two things are evident here:

1. WASM module is being loaded - in the console the message starts with `WebAssembly.instantiateStreaming`. There was an error due to a MIME-type mismatch, the web server (Vite in this case) returned `text/html` while `application/wasm` was expected.
2. There is a stack-trace of the error.

Judging from the stack trace, the problem occurred in `QrCode.tsx:28`. And this is nothing more than calling the `init` function, which internally calls the `__wbg_init` function, which in turn calls the `__wbg_load` function. If you click on the links from the console, you can see the code of these functions. At the moment of writing this article we are using the library version `0.12.5`, in your case the code may be different.

Below is the code of these functions, the lines we are interested in are highlighted.

function \_\_wbg\_init

```
async function __wbg_init(input) {
  if (wasm !== undefined) return wasm;

  if (typeof input === 'undefined') {
    input = new URL('fast_qr_bg.wasm', import.meta.url);
  }
  const imports = __wbg_get_imports();

  if (typeof input === 'string' || (typeof Request === 'function' && input instanceof Request) || (typeof URL === 'function' && input instanceof URL)) {
    input = fetch(input);
  }

  __wbg_init_memory(imports);

  const {instance, module} = await __wbg_load(await input, imports);

  return __wbg_finalize_init(instance, module);
}
```

function \_\_wbg\_load

```
async function __wbg_load(module, imports) {
  if (typeof Response === 'function' && module instanceof Response) {
    if (typeof WebAssembly.instantiateStreaming === 'function') {
      try {
        return await WebAssembly.instantiateStreaming(module, imports);

      } catch (e) {
        if (module.headers.get('Content-Type') != 'application/wasm') {
          console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);

        } else {
          throw e;
        }
      }
    }

    const bytes = await module.arrayBuffer();
    return await WebAssembly.instantiate(bytes, imports);

  } else {
    const instance = await WebAssembly.instantiate(module, imports);

    if (instance instanceof WebAssembly.Instance) {
      return {instance, module};

    } else {
      return instance;
    }
  }
}
```

If you're curious about the cryptic prefixes in the function name `__wbg_`, it's short for [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen), a utility that generates helper code for WASM modules written in Rust.

Okay, how do we solve this problem? Let's load the WASM module using Vite.

## Loading WASM module[​](#loading-wasm-module "Direct link to Loading WASM module")

Vite supports loading WebAssembly modules [out of the box](https://vitejs.dev/guide/features.html#webassembly). We just need to add `?init` to the import statement as indicated in the example in the documentation. Also, the `init` function in the `fast_qr` library can take the loaded WASM module as a parameter. The `init` function can also take the path to a WASM module as an argument. You can see the `init` function declaration, usually - in the IDE you can just do a "Go to definition" (`Ctrl`+`Click` / `⌘`+ `Click`). Here is the type description from the library (yes, yes, the `init` function is `__wbg_init`):

```
export default function __wbg_init(module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;
```

Loading the module path is also supported in Vite [out of the box](https://vitejs.dev/guide/assets.html#explicit-url-imports), all you need to do is add `?url` to the import statement.

Okay, which module should I load? It's easy to understand if you open the "Network" tab in the browser, and we can see that only one module `fast_qr_bg.wasm` is loaded:

![WASM component](/documentation/assets/images/wasm-component-05-9c1db3ccf64381d86fca70613c872b5e.png)

The fact that the module loads twice is normal, we are in development mode, and we have React [StrictMode](https://react.dev/reference/react/StrictMode) enabled.

In this article, we will load the path to the module, and pass this path to the `init` function. Here is the full text of the `src/QrCode.tsx` file (changed lines are highlighted):

src/QrCode.tsx

```
import init, {qr_svg, Shape, SvgOptions} from 'fast_qr'
import module from 'fast_qr/fast_qr_bg.wasm?url'
import {RefObject, useEffect, useRef} from 'react'
import {define} from '@react-form-builder/core'

export interface QrCodeProps {
  /**
   * The QR code width.
   */
  width?: number

  /**
   * The CSS class name.
   */
  className?: string
}

export const QrCode = (props: QrCodeProps) => {
  const ref = useRef<HTMLDivElement>(null)

  useEffect(() => {
    renderQr(ref).catch(console.error)
  }, [])

  return <div className={props.className} style={{width: props.width}} ref={ref}></div>
}

async function renderQr(ref: RefObject<HTMLDivElement>) {
  await init(module)

  if (!ref.current) return

  const options = new SvgOptions()
    .margin(4)
    .shape(Shape.Square)
    .image("")  // Can be a URL or a base64 encoded image
    .background_color("#b8a4e5")
    .module_color("#ffffff")

  ref.current.innerHTML = qr_svg("https://fast-qr.com", options)
}

export const qrCode = define(QrCode, 'QrCode')
  .name('QR code')
  .category('static')
```

Go back to your browser, add the QR code to the form, and you'll see something like this:

![WASM component](/documentation/assets/images/wasm-component-06-714f6cef68e8e602ac8d02f8fc5e0221.png)

Great, all that's left is to add properties to the component and make them editable in the designer.

## Adding properties[​](#adding-properties "Direct link to Adding properties")

As you may have noticed, the library uses the `SvgOptions` class to customize the parameters of the QR code. This class is a regular builder that is configured through a chain of function calls:

```
const options = new SvgOptions()
  .margin(4)
  .shape(Shape.Square)
  .image("")  // Can be a URL or a base64 encoded image
  .background_color("#b8a4e5")
  .module_color("#ffffff")
```

You can find the type descriptions in the file `fast_qr.d.ts` (in the `fast_qr` package in the `node_modules` folder), the file is quite large, so it is under the cut:

fast\_qr.d.ts

fast\_qr.d.ts

```
/* tslint:disable */

/* eslint-disable */
/**
 * Generate a QR code from a string. All parameters are automatically set.
 * @param {string} content
 * @returns {Uint8Array}
 */
export function qr(content: string): Uint8Array;

/**
 * Generate a QR code from a string. All parameters are automatically set.
 * @param {string} content
 * @param {SvgOptions} options
 * @returns {string}
 */
export function qr_svg(content: string, options: SvgOptions): string;

/**
 * Enum containing all possible `QRCode` versions
 */
export enum Version {
  /**
   * Version n°01
   */
  V01 = 0,
  /**
   * Version n°02
   */
  V02 = 1,
  /**
   * Version n°03
   */
  V03 = 2,
  /**
   * Version n°04
   */
  V04 = 3,
  /**
   * Version n°05
   */
  V05 = 4,
  /**
   * Version n°06
   */
  V06 = 5,
  /**
   * Version n°07
   */
  V07 = 6,
  /**
   * Version n°08
   */
  V08 = 7,
  /**
   * Version n°09
   */
  V09 = 8,
  /**
   * Version n°10
   */
  V10 = 9,
  /**
   * Version n°11
   */
  V11 = 10,
  /**
   * Version n°12
   */
  V12 = 11,
  /**
   * Version n°13
   */
  V13 = 12,
  /**
   * Version n°14
   */
  V14 = 13,
  /**
   * Version n°15
   */
  V15 = 14,
  /**
   * Version n°16
   */
  V16 = 15,
  /**
   * Version n°17
   */
  V17 = 16,
  /**
   * Version n°18
   */
  V18 = 17,
  /**
   * Version n°19
   */
  V19 = 18,
  /**
   * Version n°20
   */
  V20 = 19,
  /**
   * Version n°21
   */
  V21 = 20,
  /**
   * Version n°22
   */
  V22 = 21,
  /**
   * Version n°23
   */
  V23 = 22,
  /**
   * Version n°24
   */
  V24 = 23,
  /**
   * Version n°25
   */
  V25 = 24,
  /**
   * Version n°26
   */
  V26 = 25,
  /**
   * Version n°27
   */
  V27 = 26,
  /**
   * Version n°28
   */
  V28 = 27,
  /**
   * Version n°29
   */
  V29 = 28,
  /**
   * Version n°30
   */
  V30 = 29,
  /**
   * Version n°31
   */
  V31 = 30,
  /**
   * Version n°32
   */
  V32 = 31,
  /**
   * Version n°33
   */
  V33 = 32,
  /**
   * Version n°34
   */
  V34 = 33,
  /**
   * Version n°35
   */
  V35 = 34,
  /**
   * Version n°36
   */
  V36 = 35,
  /**
   * Version n°37
   */
  V37 = 36,
  /**
   * Version n°38
   */
  V38 = 37,
  /**
   * Version n°39
   */
  V39 = 38,
  /**
   * Version n°40
   */
  V40 = 39,
}

/**
 * Error Correction Coding has 4 levels
 */
export enum ECL {
  /**
   * Low, 7%
   */
  L = 0,
  /**
   * Medium, 15%
   */
  M = 1,
  /**
   * Quartile, 25%
   */
  Q = 2,
  /**
   * High, 30%
   */
  H = 3,
}

/**
 * Different possible Shapes to represent modules in a [`crate::QRCode`]
 */
export enum Shape {
  /**
   * Square Shape
   */
  Square = 0,
  /**
   * Circle Shape
   */
  Circle = 1,
  /**
   * RoundedSquare Shape
   */
  RoundedSquare = 2,
  /**
   * Vertical Shape
   */
  Vertical = 3,
  /**
   * Horizontal Shape
   */
  Horizontal = 4,
  /**
   * Diamond Shape
   */
  Diamond = 5,
}

/**
 * Different possible image background shapes
 */
export enum ImageBackgroundShape {
  /**
   * Square shape
   */
  Square = 0,
  /**
   * Circle shape
   */
  Circle = 1,
  /**
   * Rounded square shape
   */
  RoundedSquare = 2,
}

/**
 * Configuration for the SVG output.
 */
export class SvgOptions {
  free(): void;

  /**
   * Updates the shape of the QRCode modules.
   * @param {Shape} shape
   * @returns {SvgOptions}
   */
  shape(shape: Shape): SvgOptions;

  /**
   * Updates the module color of the QRCode. Tales a string in the format `#RRGGBB[AA]`.
   * @param {string} module_color
   * @returns {SvgOptions}
   */
  module_color(module_color: string): SvgOptions;

  /**
   * Updates the margin of the QRCode.
   * @param {number} margin
   * @returns {SvgOptions}
   */
  margin(margin: number): SvgOptions;

  /**
   * Updates the background color of the QRCode. Tales a string in the format `#RRGGBB[AA]`.
   * @param {string} background_color
   * @returns {SvgOptions}
   */
  background_color(background_color: string): SvgOptions;

  /**
   * Updates the image of the QRCode. Takes base64 or a url.
   * @param {string} image
   * @returns {SvgOptions}
   */
  image(image: string): SvgOptions;

  /**
   * Updates the background color of the image. Takes a string in the format `#RRGGBB[AA]`.
   * @param {string} image_background_color
   * @returns {SvgOptions}
   */
  image_background_color(image_background_color: string): SvgOptions;

  /**
   * Updates the shape of the image background. Takes an convert::ImageBackgroundShape.
   * @param {ImageBackgroundShape} image_background_shape
   * @returns {SvgOptions}
   */
  image_background_shape(image_background_shape: ImageBackgroundShape): SvgOptions;

  /**
   * Updates the size of the image. Takes a size and a gap (unit being module size).
   * @param {number} size
   * @param {number} gap
   * @returns {SvgOptions}
   */
  image_size(size: number, gap: number): SvgOptions;

  /**
   * Updates the position of the image. Takes an array [x, y] (unit being module size).
   * @param {Float64Array} image_position
   * @returns {SvgOptions}
   */
  image_position(image_position: Float64Array): SvgOptions;

  /**
   * Updates the error correction level of the QRCode (can increase the size of the QRCode)
   * @param {ECL} ecl
   * @returns {SvgOptions}
   */
  ecl(ecl: ECL): SvgOptions;

  /**
   * Forces the version of the QRCode
   * @param {Version} version
   * @returns {SvgOptions}
   */
  version(version: Version): SvgOptions;

  /**
   * Creates a new SvgOptions object.
   */
  constructor();
}

export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;

export interface InitOutput {
  readonly memory: WebAssembly.Memory;
  readonly qr: (a: number, b: number, c: number) => void;
  readonly __wbg_svgoptions_free: (a: number) => void;
  readonly svgoptions_shape: (a: number, b: number) => number;
  readonly svgoptions_module_color: (a: number, b: number, c: number) => number;
  readonly svgoptions_margin: (a: number, b: number) => number;
  readonly svgoptions_background_color: (a: number, b: number, c: number) => number;
  readonly svgoptions_image: (a: number, b: number, c: number) => number;
  readonly svgoptions_image_background_color: (a: number, b: number, c: number) => number;
  readonly svgoptions_image_background_shape: (a: number, b: number) => number;
  readonly svgoptions_image_size: (a: number, b: number, c: number) => number;
  readonly svgoptions_image_position: (a: number, b: number, c: number) => number;
  readonly svgoptions_ecl: (a: number, b: number) => number;
  readonly svgoptions_version: (a: number, b: number) => number;
  readonly svgoptions_new: () => number;
  readonly qr_svg: (a: number, b: number, c: number, d: number) => void;
  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
  readonly __wbindgen_malloc: (a: number, b: number) => number;
  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
}

export type SyncInitInput = BufferSource | WebAssembly.Module;

/**
 * Instantiates the given `module`, which can either be bytes or
 * a precompiled `WebAssembly.Module`.
 *
 * @param {SyncInitInput} module
 *
 * @returns {InitOutput}
 */
export function initSync(module: SyncInitInput): InitOutput;

/**
 * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
 * for everything else, calls `WebAssembly.instantiate` directly.
 *
 * @param {InitInput | Promise<InitInput>} module_or_path
 *
 * @returns {Promise<InitOutput>}
 */
export default function __wbg_init(module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;
```

What's left to do:

1. Add the necessary properties to the `QrCodeProps` interface for our `QrCode` component.
2. Pass the property values to the corresponding methods of the `SvgOptions` object.
3. Describe the added properties in the `qrCode` object using `props`.

Below is the code of the component, it adds all of the above. In the code you will also find a color converter from the rgba format, which is passed by the designer property editor, to the hex format used by the component.

src/QrCode.tsx

src/QrCode.tsx

```
import init, {qr_svg, SvgOptions} from 'fast_qr'
import module from 'fast_qr/fast_qr_bg.wasm?url'
import {RefObject, useEffect, useRef} from 'react'
import {color, define, number, oneOf, string} from '@react-form-builder/core'

export interface QrCodeProps {
  /**
   * The QR code width.
   */
  width?: number

  /**
   * The CSS class name.
   */
  className?: string

  /**
   * The QR code content.
   */
  content: string

  /**
   * The different possible shapes to represent modules.
   */
  shape?: number

  /**
   * The background color.
   */
  backgroundColor?: string

  /**
   * The module color.
   */
  moduleColor?: string

  /**
   * The margin.
   */
  margin?: number

  /**
   * The image, base64 or URL.
   */
  image?: string

  /**
   * The image background color.
   */
  imageBackgroundColor?: string

  /**
   * The image background shape.
   */
  imageBackgroundShape?: number

  /**
   * The image X position in module units.
   */
  imagePositionX?: number

  /**
   * The image Y position in module units.
   */
  imagePositionY?: number

  /**
   * Image size in module units.
   */
  imageSize?: number

  /**
   * Image gap in module units.
   */
  imageGap?: number

  /**
   * The error correction coding level.
   */
  errorCorrectionLevel?: number

  /**
   * The QR code version.
   */
  version?: number
}

export const QrCode = (props: QrCodeProps) => {
  const ref = useRef<HTMLDivElement>(null)

  useEffect(() => {
    renderQr(props, ref).catch(console.error)
  }, [props])

  return <div className={props.className} style={{width: props.width}} ref={ref}></div>
}

const colorPartToHex = (color: number) => {
  if (color % 1 === 0) return (color | 1 << 8).toString(16).slice(1)
  return Math.trunc((color * 255) | 1 << 8).toString(16).slice(1)
}

const rgbaColorToHex = (color?: string) => {
  if (!color) return undefined

  const index = color.indexOf(')')
  if (color.startsWith('rgba(') && index >= 0) {
    const colors = color.substring(5, index)
      .split(',')
      .map(s => s.trim())
      .map(s => Number(s))
      .map(colorPartToHex)
      .join('')
    return `#${colors}`
  }
}

async function renderQr(props: QrCodeProps, ref: RefObject<HTMLDivElement>) {
  await init(module)

  if (!ref.current) return

  let svgOptions = new SvgOptions()
  if (props.margin) svgOptions = svgOptions.margin(props.margin)

  const backgroundColor = rgbaColorToHex(props.backgroundColor)
  if (backgroundColor) svgOptions = svgOptions.background_color(backgroundColor)

  const moduleColor = rgbaColorToHex(props.moduleColor)
  if (moduleColor) svgOptions = svgOptions.module_color(moduleColor)

  if (props.shape) svgOptions = svgOptions.shape(props.shape)
  if (props.image) svgOptions = svgOptions.image(props.image)

  const imageBackgroundColor = rgbaColorToHex(props.imageBackgroundColor)
  if (imageBackgroundColor) svgOptions = svgOptions.image_background_color(imageBackgroundColor)

  if (props.imageBackgroundShape) svgOptions = svgOptions.image_background_shape(props.imageBackgroundShape)
  if (props.imageSize !== undefined && props.imageGap !== undefined) {
    svgOptions = svgOptions.image_size(props.imageSize, props.imageGap)
  }
  if (props.imagePositionX && props.imagePositionY) {
    const position = new Float64Array([props.imagePositionX, props.imagePositionY])
    svgOptions = svgOptions.image_position(position)
  }

  if (props.errorCorrectionLevel) svgOptions = svgOptions.ecl(props.errorCorrectionLevel)
  if (props.version) svgOptions = svgOptions.version(props.version)

  ref.current.innerHTML = qr_svg(props.content, svgOptions)
}

const nonNegNumber = number.withEditorProps({min: 0})

export const qrCode = define(QrCode, 'QrCode')
  .name('QR code')
  .category('static')
  .props({
    width: nonNegNumber.default(300).hinted('The QR code width'),
    content: string.default('https://formengine.io').hinted('The QR code content'),
    moduleColor: color.hinted('The module color'),
    shape: oneOf(0, 1, 2, 3, 4, 5).default(0)
      .labeled('Square', 'Circle', 'RoundedSquare', 'Vertical', 'Horizontal', 'Diamond')
      .withEditorProps({creatable: false})
      .hinted('The different possible shapes to represent modules'),
    errorCorrectionLevel: oneOf(0, 1, 2, 3).default(0)
      .labeled('Low, 7%', 'Medium, 15%', 'Quartile, 25%', 'High, 30%')
      .withEditorProps({creatable: false})
      .hinted('The error correction coding level'),
    version: number.withEditorProps({min: 0, max: 39})
      .named('QR version')
      .hinted('The QR code version'),
    image: string.hinted('The image, base64 or URL'),
    imageBackgroundColor: color.hinted('The image background color'),
    imageBackgroundShape: oneOf(0, 1, 2).default(0)
      .labeled('Square', 'Circle', 'RoundedSquare')
      .withEditorProps({creatable: false})
      .hinted('The image background shape'),
  })
```

Now we have a fully functional component that we can play with in the designer:

![WASM component](/documentation/assets/images/wasm-component-07-3bd6acb1cf4cdabbcd05ab66e3f07c1e.png)

## Conclusion[​](#conclusion "Direct link to Conclusion")

Connecting a WASM component to a React application is not a difficult task. We will add the QR code component to the FormEngine component collection so that you can easily connect it via the usual npm dependency.


---

# API reference

## Packages[​](#packages "Direct link to Packages")

* [@react-form-builder/components-fast-qr](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/)
* [@react-form-builder/components-google-map](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/)
* [@react-form-builder/components-material-ui](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/)
* [@react-form-builder/components-rich-text](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/)
* [@react-form-builder/components-rsuite](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/)
* [@react-form-builder/components-rsuite-table](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/)
* [@react-form-builder/components-signature](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/)
* [@react-form-builder/components-uploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/)
* [@react-form-builder/core](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/)
* [@react-form-builder/designer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/)
* [@react-form-builder/designer-bundle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/)
* [@react-form-builder/json-schema-generator](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/json-schema-generator/)
* [@react-form-builder/viewer-bundle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/)
* [@react-form-builder/viewer-bundle-premium](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/)


---

# @react-form-builder/components-fast-qr

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [FastQrProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/interfaces/FastQrProps)

## Variables[​](#variables "Direct link to Variables")

* [fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponent)
* [fastQrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponentsDescriptions)
* [fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrEnUsComponentsDescriptions)
* [fastQrModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrModel)


---

# Interface: FastQrProps

The Fast QR component properties.

## Properties[​](#properties "Direct link to Properties")

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

***

### content[​](#content "Direct link to content")

> **content**: `string`

The QR code content.

***

### errorCorrectionLevel?[​](#errorcorrectionlevel "Direct link to errorCorrectionLevel?")

> `optional` **errorCorrectionLevel**: `number`

The error correction coding level.

***

### image?[​](#image "Direct link to image?")

> `optional` **image**: `string`

The image, base64 or URL.

***

### imageBackgroundColor?[​](#imagebackgroundcolor "Direct link to imageBackgroundColor?")

> `optional` **imageBackgroundColor**: `string`

The image background color.

***

### imageBackgroundShape?[​](#imagebackgroundshape "Direct link to imageBackgroundShape?")

> `optional` **imageBackgroundShape**: `number`

The image background shape.

***

### imageGap?[​](#imagegap "Direct link to imageGap?")

> `optional` **imageGap**: `number`

Image gap in module units.

***

### imagePositionX?[​](#imagepositionx "Direct link to imagePositionX?")

> `optional` **imagePositionX**: `number`

The image X position in module units.

***

### imagePositionY?[​](#imagepositiony "Direct link to imagePositionY?")

> `optional` **imagePositionY**: `number`

The image Y position in module units.

***

### imageSize?[​](#imagesize "Direct link to imageSize?")

> `optional` **imageSize**: `number`

Image size in module units.

***

### margin?[​](#margin "Direct link to margin?")

> `optional` **margin**: `number`

The margin.

***

### moduleColor?[​](#modulecolor "Direct link to moduleColor?")

> `optional` **moduleColor**: `string`

The module color.

***

### shape?[​](#shape "Direct link to shape?")

> `optional` **shape**: `number`

The different possible shapes to represent modules.

***

### version?[​](#version "Direct link to version?")

> `optional` **version**: `number`

The QR code version.

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `number`

The QR code width.


---

# Variable: fastQrComponent

> `const` **fastQrComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`FastQrProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/interfaces/FastQrProps)> = `fastQr`


---

# Variable: fastQrComponentsDescriptions

> `const` **fastQrComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: fastQrEnUsComponentsDescriptions

> **fastQrEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.static[​](#categoriesstatic "Direct link to categories.static")

> **categories.static**: `object`

#### categories.static.name[​](#categoriesstaticname "Direct link to categories.static.name")

> **categories.static.name**: `string` = `"Static"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.FastQR[​](#componentsfastqr "Direct link to components.FastQR")

> **components.FastQR**: `object`

#### components.FastQR.description[​](#componentsfastqrdescription "Direct link to components.FastQR.description")

> **components.FastQR.description**: `string` = `"Component that can convert text into QR codes, and support custom color and logo"`

#### components.FastQR.name[​](#componentsfastqrname "Direct link to components.FastQR.name")

> **components.FastQR.name**: `string` = `"QR Code"`

#### components.FastQR.props[​](#componentsfastqrprops "Direct link to components.FastQR.props")

> **components.FastQR.props**: `object`

#### components.FastQR.props.content[​](#componentsfastqrpropscontent "Direct link to components.FastQR.props.content")

> **components.FastQR.props.content**: `object`

#### components.FastQR.props.content.description[​](#componentsfastqrpropscontentdescription "Direct link to components.FastQR.props.content.description")

> **components.FastQR.props.content.description**: `string` = `"The QR code content"`

#### components.FastQR.props.content.name[​](#componentsfastqrpropscontentname "Direct link to components.FastQR.props.content.name")

> **components.FastQR.props.content.name**: `string` = `"Content"`

#### components.FastQR.props.errorCorrectionLevel[​](#componentsfastqrpropserrorcorrectionlevel "Direct link to components.FastQR.props.errorCorrectionLevel")

> **components.FastQR.props.errorCorrectionLevel**: `object`

#### components.FastQR.props.errorCorrectionLevel.description[​](#componentsfastqrpropserrorcorrectionleveldescription "Direct link to components.FastQR.props.errorCorrectionLevel.description")

> **components.FastQR.props.errorCorrectionLevel.description**: `string` = `"The error correction coding level"`

#### components.FastQR.props.errorCorrectionLevel.name[​](#componentsfastqrpropserrorcorrectionlevelname "Direct link to components.FastQR.props.errorCorrectionLevel.name")

> **components.FastQR.props.errorCorrectionLevel.name**: `string` = `"Error correction level"`

#### components.FastQR.props.image[​](#componentsfastqrpropsimage "Direct link to components.FastQR.props.image")

> **components.FastQR.props.image**: `object`

#### components.FastQR.props.image.description[​](#componentsfastqrpropsimagedescription "Direct link to components.FastQR.props.image.description")

> **components.FastQR.props.image.description**: `string` = `"The image, base64 or URL"`

#### components.FastQR.props.image.name[​](#componentsfastqrpropsimagename "Direct link to components.FastQR.props.image.name")

> **components.FastQR.props.image.name**: `string` = `"Image"`

#### components.FastQR.props.imageBackgroundColor[​](#componentsfastqrpropsimagebackgroundcolor "Direct link to components.FastQR.props.imageBackgroundColor")

> **components.FastQR.props.imageBackgroundColor**: `object`

#### components.FastQR.props.imageBackgroundColor.description[​](#componentsfastqrpropsimagebackgroundcolordescription "Direct link to components.FastQR.props.imageBackgroundColor.description")

> **components.FastQR.props.imageBackgroundColor.description**: `string` = `"The image background color"`

#### components.FastQR.props.imageBackgroundColor.name[​](#componentsfastqrpropsimagebackgroundcolorname "Direct link to components.FastQR.props.imageBackgroundColor.name")

> **components.FastQR.props.imageBackgroundColor.name**: `string` = `"Image background color"`

#### components.FastQR.props.imageBackgroundShape[​](#componentsfastqrpropsimagebackgroundshape "Direct link to components.FastQR.props.imageBackgroundShape")

> **components.FastQR.props.imageBackgroundShape**: `object`

#### components.FastQR.props.imageBackgroundShape.description[​](#componentsfastqrpropsimagebackgroundshapedescription "Direct link to components.FastQR.props.imageBackgroundShape.description")

> **components.FastQR.props.imageBackgroundShape.description**: `string` = `"The image background shape"`

#### components.FastQR.props.imageBackgroundShape.name[​](#componentsfastqrpropsimagebackgroundshapename "Direct link to components.FastQR.props.imageBackgroundShape.name")

> **components.FastQR.props.imageBackgroundShape.name**: `string` = `"Image background shape"`

#### components.FastQR.props.moduleColor[​](#componentsfastqrpropsmodulecolor "Direct link to components.FastQR.props.moduleColor")

> **components.FastQR.props.moduleColor**: `object`

#### components.FastQR.props.moduleColor.description[​](#componentsfastqrpropsmodulecolordescription "Direct link to components.FastQR.props.moduleColor.description")

> **components.FastQR.props.moduleColor.description**: `string` = `"The module color"`

#### components.FastQR.props.moduleColor.name[​](#componentsfastqrpropsmodulecolorname "Direct link to components.FastQR.props.moduleColor.name")

> **components.FastQR.props.moduleColor.name**: `string` = `"Module color"`

#### components.FastQR.props.shape[​](#componentsfastqrpropsshape "Direct link to components.FastQR.props.shape")

> **components.FastQR.props.shape**: `object`

#### components.FastQR.props.shape.description[​](#componentsfastqrpropsshapedescription "Direct link to components.FastQR.props.shape.description")

> **components.FastQR.props.shape.description**: `string` = `"The different possible shapes to represent modules"`

#### components.FastQR.props.shape.name[​](#componentsfastqrpropsshapename "Direct link to components.FastQR.props.shape.name")

> **components.FastQR.props.shape.name**: `string` = `"Shape"`

#### components.FastQR.props.version[​](#componentsfastqrpropsversion "Direct link to components.FastQR.props.version")

> **components.FastQR.props.version**: `object`

#### components.FastQR.props.version.description[​](#componentsfastqrpropsversiondescription "Direct link to components.FastQR.props.version.description")

> **components.FastQR.props.version.description**: `string` = `"The QR code version"`

#### components.FastQR.props.version.name[​](#componentsfastqrpropsversionname "Direct link to components.FastQR.props.version.name")

> **components.FastQR.props.version.name**: `string` = `"QR version"`

#### components.FastQR.props.width[​](#componentsfastqrpropswidth "Direct link to components.FastQR.props.width")

> **components.FastQR.props.width**: `object`

#### components.FastQR.props.width.description[​](#componentsfastqrpropswidthdescription "Direct link to components.FastQR.props.width.description")

> **components.FastQR.props.width.description**: `string` = `"The QR code width"`

#### components.FastQR.props.width.name[​](#componentsfastqrpropswidthname "Direct link to components.FastQR.props.width.name")

> **components.FastQR.props.width.name**: `string` = `"Width"`


---

# Variable: fastQrModel

> `const` **fastQrModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# @react-form-builder/components-google-map

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [GoogleMapProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/interfaces/GoogleMapProps)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

* [Address](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address)
* [MapMarker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker)

## Variables[​](#variables "Direct link to Variables")

* [googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponent)
* [googleMapComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponentsDescriptions)
* [googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapEnUsComponentsDescriptions)
* [googleMapModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapModel)

## Functions[​](#functions "Direct link to Functions")

* [toAddress](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/functions/toAddress)


---

# Function: toAddress()

> **toAddress**(`components`): [`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address)

Converts the address components to an address object. Original source code from <https://developers.google.com/maps/documentation/javascript/examples/places-autocomplete-addressform>.

## Parameters[​](#parameters "Direct link to Parameters")

### components[​](#components "Direct link to components")

`GeocoderAddressComponent`\[]

the address components.

## Returns[​](#returns "Direct link to Returns")

[`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address)

the address object.


---

# Interface: GoogleMapProps

Props for the GoogleMap component.

## Properties[​](#properties "Direct link to Properties")

### addMarkerOnSearch[​](#addmarkeronsearch "Direct link to addMarkerOnSearch")

> **addMarkerOnSearch**: `boolean`

Whether to add a marker on search.

***

### allowChangingMarkers[​](#allowchangingmarkers "Direct link to allowChangingMarkers")

> **allowChangingMarkers**: `boolean`

If true, the user can change the markers.

***

### allowMultipleMarkers?[​](#allowmultiplemarkers "Direct link to allowMultipleMarkers?")

> `optional` **allowMultipleMarkers**: `boolean`

Whether multiple markers can be added to the map. Defaults to false.

***

### apiKey[​](#apikey "Direct link to apiKey")

> **apiKey**: `string`

Google Maps API key used to load the map.

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

***

### collisionBehavior?[​](#collisionbehavior "Direct link to collisionBehavior?")

> `optional` **collisionBehavior**: `CollisionBehavior`

The markers collision behavior.

***

### colorScheme?[​](#colorscheme "Direct link to colorScheme?")

> `optional` **colorScheme**: `"DARK"` | `"LIGHT"` | `"FOLLOW_SYSTEM"`

The color scheme to use for the map.

***

### gestureHandling?[​](#gesturehandling "Direct link to gestureHandling?")

> `optional` **gestureHandling**: `"none"` | `"auto"` | `"cooperative"` | `"greedy"`

This setting controls how the API handles gestures on the map.

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label of the component.

***

### language?[​](#language "Direct link to language?")

> `optional` **language**: `string`

Use a specific language for the map. Read more about localizing the Map: <https://developers.google.com/maps/documentation/javascript/localization>. Part of: <https://developers.google.com/maps/documentation/javascript/url-params>.

***

### latitude[​](#latitude "Direct link to latitude")

> **latitude**: `number`

Latitude of the center point on the map.

***

### longitude[​](#longitude "Direct link to longitude")

> **longitude**: `number`

Longitude of the center point on the map.

***

### mapControlPosition[​](#mapcontrolposition "Direct link to mapControlPosition")

> **mapControlPosition**: `ControlPosition`

The position of the map control.

***

### mapId?[​](#mapid "Direct link to mapId?")

> `optional` **mapId**: `string`

The map ID is an identifier that's associated with a specific map style or feature.

***

### mapTypeId[​](#maptypeid "Direct link to mapTypeId")

> **mapTypeId**: `"hybrid"` | `"roadmap"` | `"satellite"` | `"terrain"`

The default map type to use.

***

### markers?[​](#markers "Direct link to markers?")

> `optional` **markers**: [`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker)\[]

Coordinates of the markers

***

### markerWindowTitle[​](#markerwindowtitle "Direct link to markerWindowTitle")

> **markerWindowTitle**: `string`

The title for the marker window.

***

### onMapClick()?[​](#onmapclick "Direct link to onMapClick()?")

> `optional` **onMapClick**: (`event`) => `void`

The callback function called when the map is clicked.

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`MapMouseEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### onMarkerAdd()?[​](#onmarkeradd "Direct link to onMarkerAdd()?")

> `optional` **onMarkerAdd**: (`marker`) => `void`

The callback function called when a marker is added.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### marker[​](#marker "Direct link to marker")

[`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker)

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### onMarkerClick()?[​](#onmarkerclick "Direct link to onMarkerClick()?")

> `optional` **onMarkerClick**: (`marker`, `element`) => `void`

The callback function called when a marker is clicked.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### marker[​](#marker-1 "Direct link to marker")

`null` | [`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker)

##### element[​](#element "Direct link to element")

`AdvancedMarkerElement`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

***

### onMarkerDelete()?[​](#onmarkerdelete "Direct link to onMarkerDelete()?")

> `optional` **onMarkerDelete**: (`marker`) => `void`

The callback function called when a marker is deleted.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### marker[​](#marker-2 "Direct link to marker")

[`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker)

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### onPlaceSelect()?[​](#onplaceselect "Direct link to onPlaceSelect()?")

> `optional` **onPlaceSelect**: (`place`, `address?`) => `void`

The callback function called when a place is selected.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### place[​](#place "Direct link to place")

`PlaceResult`

the selected place.

##### address?[​](#address "Direct link to address?")

[`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address)

the address of the selected place.

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

***

### region?[​](#region "Direct link to region?")

> `optional` **region**: `string`

Sets the map to a specific region. Read more about localizing the Map: <https://developers.google.com/maps/documentation/javascript/localization>. Part of: <https://developers.google.com/maps/documentation/javascript/url-params>.

***

### removeMarkerCaption[​](#removemarkercaption "Direct link to removeMarkerCaption")

> **removeMarkerCaption**: `string`

The caption for the remove marker button.

***

### searchPlaceholder?[​](#searchplaceholder "Direct link to searchPlaceholder?")

> `optional` **searchPlaceholder**: `string`

The search input placeholder.

***

### showMapControl[​](#showmapcontrol "Direct link to showMapControl")

> **showMapControl**: `ControlPosition`

Whether to show the map control.

***

### zoom[​](#zoom "Direct link to zoom")

> **zoom**: `number`

Zoom level of the map.


---

# Type Alias: Address

> **Address** = `object`

Represents an address.

## Properties[​](#properties "Direct link to Properties")

### address?[​](#address "Direct link to address?")

> `optional` **address**: `string`

The first line of the address.

***

### city?[​](#city "Direct link to city?")

> `optional` **city**: `string`

The city of the address.

***

### country?[​](#country "Direct link to country?")

> `optional` **country**: `string`

The country of the address.

***

### postalCode?[​](#postalcode "Direct link to postalCode?")

> `optional` **postalCode**: `string`

The postal code of the address.

***

### state?[​](#state "Direct link to state?")

> `optional` **state**: `string`

The state of the address.


---

# Type Alias: MapMarker

> **MapMarker** = `object`

Represents the marker data on the map.

## Properties[​](#properties "Direct link to Properties")

### address?[​](#address "Direct link to address?")

> `optional` **address**: [`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address)

The address of the location.

***

### id[​](#id "Direct link to id")

> **id**: `string`

The unique identifier of the marker.

***

### position[​](#position "Direct link to position")

> **position**: `google.maps.LatLngLiteral`

Latitude and longitude of the geographical location.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

The title of the marker.

***

### zIndex[​](#zindex "Direct link to zIndex")

> **zIndex**: `number`

The z-index of the marker.


---

# Variable: googleMapComponent

> `const` **googleMapComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`GoogleMapProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/interfaces/GoogleMapProps)> = `googleMap`


---

# Variable: googleMapComponentsDescriptions

> `const` **googleMapComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: googleMapEnUsComponentsDescriptions

> **googleMapEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.fields[​](#categoriesfields "Direct link to categories.fields")

> **categories.fields**: `object`

#### categories.fields.name[​](#categoriesfieldsname "Direct link to categories.fields.name")

> **categories.fields.name**: `string` = `"Fields"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.GoogleMap[​](#componentsgooglemap "Direct link to components.GoogleMap")

> **components.GoogleMap**: `object`

#### components.GoogleMap.description[​](#componentsgooglemapdescription "Direct link to components.GoogleMap.description")

> **components.GoogleMap.description**: `string` = `"Component displaying a Google map"`

#### components.GoogleMap.name[​](#componentsgooglemapname "Direct link to components.GoogleMap.name")

> **components.GoogleMap.name**: `string` = `"Google Map"`

#### components.GoogleMap.props[​](#componentsgooglemapprops "Direct link to components.GoogleMap.props")

> **components.GoogleMap.props**: `object`

#### components.GoogleMap.props.addMarkerOnSearch[​](#componentsgooglemappropsaddmarkeronsearch "Direct link to components.GoogleMap.props.addMarkerOnSearch")

> **components.GoogleMap.props.addMarkerOnSearch**: `object`

#### components.GoogleMap.props.addMarkerOnSearch.description[​](#componentsgooglemappropsaddmarkeronsearchdescription "Direct link to components.GoogleMap.props.addMarkerOnSearch.description")

> **components.GoogleMap.props.addMarkerOnSearch.description**: `string` = `"Whether to add a marker on search"`

#### components.GoogleMap.props.addMarkerOnSearch.name[​](#componentsgooglemappropsaddmarkeronsearchname "Direct link to components.GoogleMap.props.addMarkerOnSearch.name")

> **components.GoogleMap.props.addMarkerOnSearch.name**: `string` = `"Add marker on search"`

#### components.GoogleMap.props.allowChangingMarkers[​](#componentsgooglemappropsallowchangingmarkers "Direct link to components.GoogleMap.props.allowChangingMarkers")

> **components.GoogleMap.props.allowChangingMarkers**: `object`

#### components.GoogleMap.props.allowChangingMarkers.description[​](#componentsgooglemappropsallowchangingmarkersdescription "Direct link to components.GoogleMap.props.allowChangingMarkers.description")

> **components.GoogleMap.props.allowChangingMarkers.description**: `string` = `"If checked, the user can change the markers"`

#### components.GoogleMap.props.allowChangingMarkers.name[​](#componentsgooglemappropsallowchangingmarkersname "Direct link to components.GoogleMap.props.allowChangingMarkers.name")

> **components.GoogleMap.props.allowChangingMarkers.name**: `string` = `"Allow changing markers"`

#### components.GoogleMap.props.allowMultipleMarkers[​](#componentsgooglemappropsallowmultiplemarkers "Direct link to components.GoogleMap.props.allowMultipleMarkers")

> **components.GoogleMap.props.allowMultipleMarkers**: `object`

#### components.GoogleMap.props.allowMultipleMarkers.description[​](#componentsgooglemappropsallowmultiplemarkersdescription "Direct link to components.GoogleMap.props.allowMultipleMarkers.description")

> **components.GoogleMap.props.allowMultipleMarkers.description**: `string` = `"Multiple markers"`

#### components.GoogleMap.props.allowMultipleMarkers.name[​](#componentsgooglemappropsallowmultiplemarkersname "Direct link to components.GoogleMap.props.allowMultipleMarkers.name")

> **components.GoogleMap.props.allowMultipleMarkers.name**: `string` = `"Allow multiple markers"`

#### components.GoogleMap.props.apiKey[​](#componentsgooglemappropsapikey "Direct link to components.GoogleMap.props.apiKey")

> **components.GoogleMap.props.apiKey**: `object`

#### components.GoogleMap.props.apiKey.description[​](#componentsgooglemappropsapikeydescription "Direct link to components.GoogleMap.props.apiKey.description")

> **components.GoogleMap.props.apiKey.description**: `string` = `"Google Maps API key"`

#### components.GoogleMap.props.apiKey.name[​](#componentsgooglemappropsapikeyname "Direct link to components.GoogleMap.props.apiKey.name")

> **components.GoogleMap.props.apiKey.name**: `string` = `"API key"`

#### components.GoogleMap.props.collisionBehavior[​](#componentsgooglemappropscollisionbehavior "Direct link to components.GoogleMap.props.collisionBehavior")

> **components.GoogleMap.props.collisionBehavior**: `object`

#### components.GoogleMap.props.collisionBehavior.description[​](#componentsgooglemappropscollisionbehaviordescription "Direct link to components.GoogleMap.props.collisionBehavior.description")

> **components.GoogleMap.props.collisionBehavior.description**: `string` = `"The markers collision behavior"`

#### components.GoogleMap.props.collisionBehavior.name[​](#componentsgooglemappropscollisionbehaviorname "Direct link to components.GoogleMap.props.collisionBehavior.name")

> **components.GoogleMap.props.collisionBehavior.name**: `string` = `"Collision behavior"`

#### components.GoogleMap.props.colorScheme[​](#componentsgooglemappropscolorscheme "Direct link to components.GoogleMap.props.colorScheme")

> **components.GoogleMap.props.colorScheme**: `object`

#### components.GoogleMap.props.colorScheme.description[​](#componentsgooglemappropscolorschemedescription "Direct link to components.GoogleMap.props.colorScheme.description")

> **components.GoogleMap.props.colorScheme.description**: `string` = `"The color scheme to use"`

#### components.GoogleMap.props.colorScheme.name[​](#componentsgooglemappropscolorschemename "Direct link to components.GoogleMap.props.colorScheme.name")

> **components.GoogleMap.props.colorScheme.name**: `string` = `"Color scheme"`

#### components.GoogleMap.props.gestureHandling[​](#componentsgooglemappropsgesturehandling "Direct link to components.GoogleMap.props.gestureHandling")

> **components.GoogleMap.props.gestureHandling**: `object`

#### components.GoogleMap.props.gestureHandling.description[​](#componentsgooglemappropsgesturehandlingdescription "Direct link to components.GoogleMap.props.gestureHandling.description")

> **components.GoogleMap.props.gestureHandling.description**: `string` = `"The gesture handling to use"`

#### components.GoogleMap.props.gestureHandling.name[​](#componentsgooglemappropsgesturehandlingname "Direct link to components.GoogleMap.props.gestureHandling.name")

> **components.GoogleMap.props.gestureHandling.name**: `string` = `"Gesture handling"`

#### components.GoogleMap.props.height[​](#componentsgooglemappropsheight "Direct link to components.GoogleMap.props.height")

> **components.GoogleMap.props.height**: `object`

#### components.GoogleMap.props.height.description[​](#componentsgooglemappropsheightdescription "Direct link to components.GoogleMap.props.height.description")

> **components.GoogleMap.props.height.description**: `string` = `"Height of the map"`

#### components.GoogleMap.props.height.name[​](#componentsgooglemappropsheightname "Direct link to components.GoogleMap.props.height.name")

> **components.GoogleMap.props.height.name**: `string` = `"Height"`

#### components.GoogleMap.props.label[​](#componentsgooglemappropslabel "Direct link to components.GoogleMap.props.label")

> **components.GoogleMap.props.label**: `object`

#### components.GoogleMap.props.label.description[​](#componentsgooglemappropslabeldescription "Direct link to components.GoogleMap.props.label.description")

> **components.GoogleMap.props.label.description**: `string` = `"Map label"`

#### components.GoogleMap.props.label.name[​](#componentsgooglemappropslabelname "Direct link to components.GoogleMap.props.label.name")

> **components.GoogleMap.props.label.name**: `string` = `"Label"`

#### components.GoogleMap.props.language[​](#componentsgooglemappropslanguage "Direct link to components.GoogleMap.props.language")

> **components.GoogleMap.props.language**: `object`

#### components.GoogleMap.props.language.description[​](#componentsgooglemappropslanguagedescription "Direct link to components.GoogleMap.props.language.description")

> **components.GoogleMap.props.language.description**: `string` = `"The language to use"`

#### components.GoogleMap.props.language.name[​](#componentsgooglemappropslanguagename "Direct link to components.GoogleMap.props.language.name")

> **components.GoogleMap.props.language.name**: `string` = `"Language"`

#### components.GoogleMap.props.latitude[​](#componentsgooglemappropslatitude "Direct link to components.GoogleMap.props.latitude")

> **components.GoogleMap.props.latitude**: `object`

#### components.GoogleMap.props.latitude.description[​](#componentsgooglemappropslatitudedescription "Direct link to components.GoogleMap.props.latitude.description")

> **components.GoogleMap.props.latitude.description**: `string` = `"Latitude of the center point"`

#### components.GoogleMap.props.latitude.name[​](#componentsgooglemappropslatitudename "Direct link to components.GoogleMap.props.latitude.name")

> **components.GoogleMap.props.latitude.name**: `string` = `"Latitude"`

#### components.GoogleMap.props.longitude[​](#componentsgooglemappropslongitude "Direct link to components.GoogleMap.props.longitude")

> **components.GoogleMap.props.longitude**: `object`

#### components.GoogleMap.props.longitude.description[​](#componentsgooglemappropslongitudedescription "Direct link to components.GoogleMap.props.longitude.description")

> **components.GoogleMap.props.longitude.description**: `string` = `"Longitude of the center point"`

#### components.GoogleMap.props.longitude.name[​](#componentsgooglemappropslongitudename "Direct link to components.GoogleMap.props.longitude.name")

> **components.GoogleMap.props.longitude.name**: `string` = `"Longitude"`

#### components.GoogleMap.props.mapControlPosition[​](#componentsgooglemappropsmapcontrolposition "Direct link to components.GoogleMap.props.mapControlPosition")

> **components.GoogleMap.props.mapControlPosition**: `object`

#### components.GoogleMap.props.mapControlPosition.description[​](#componentsgooglemappropsmapcontrolpositiondescription "Direct link to components.GoogleMap.props.mapControlPosition.description")

> **components.GoogleMap.props.mapControlPosition.description**: `string` = `"The position of the map control"`

#### components.GoogleMap.props.mapControlPosition.name[​](#componentsgooglemappropsmapcontrolpositionname "Direct link to components.GoogleMap.props.mapControlPosition.name")

> **components.GoogleMap.props.mapControlPosition.name**: `string` = `"Map control position"`

#### components.GoogleMap.props.mapId[​](#componentsgooglemappropsmapid "Direct link to components.GoogleMap.props.mapId")

> **components.GoogleMap.props.mapId**: `object`

#### components.GoogleMap.props.mapId.description[​](#componentsgooglemappropsmapiddescription "Direct link to components.GoogleMap.props.mapId.description")

> **components.GoogleMap.props.mapId.description**: `string` = `"The map ID is an identifier that's associated with a specific map style or feature"`

#### components.GoogleMap.props.mapId.name[​](#componentsgooglemappropsmapidname "Direct link to components.GoogleMap.props.mapId.name")

> **components.GoogleMap.props.mapId.name**: `string` = `"Map ID"`

#### components.GoogleMap.props.mapTypeId[​](#componentsgooglemappropsmaptypeid "Direct link to components.GoogleMap.props.mapTypeId")

> **components.GoogleMap.props.mapTypeId**: `object`

#### components.GoogleMap.props.mapTypeId.description[​](#componentsgooglemappropsmaptypeiddescription "Direct link to components.GoogleMap.props.mapTypeId.description")

> **components.GoogleMap.props.mapTypeId.description**: `string` = `"The default map type to use"`

#### components.GoogleMap.props.mapTypeId.name[​](#componentsgooglemappropsmaptypeidname "Direct link to components.GoogleMap.props.mapTypeId.name")

> **components.GoogleMap.props.mapTypeId.name**: `string` = `"Map type"`

#### components.GoogleMap.props.markers[​](#componentsgooglemappropsmarkers "Direct link to components.GoogleMap.props.markers")

> **components.GoogleMap.props.markers**: `object`

#### components.GoogleMap.props.markers.description[​](#componentsgooglemappropsmarkersdescription "Direct link to components.GoogleMap.props.markers.description")

> **components.GoogleMap.props.markers.description**: `string` = `"Coordinates of the markers"`

#### components.GoogleMap.props.markers.name[​](#componentsgooglemappropsmarkersname "Direct link to components.GoogleMap.props.markers.name")

> **components.GoogleMap.props.markers.name**: `string` = `"Markers"`

#### components.GoogleMap.props.markerWindowTitle[​](#componentsgooglemappropsmarkerwindowtitle "Direct link to components.GoogleMap.props.markerWindowTitle")

> **components.GoogleMap.props.markerWindowTitle**: `object`

#### components.GoogleMap.props.markerWindowTitle.description[​](#componentsgooglemappropsmarkerwindowtitledescription "Direct link to components.GoogleMap.props.markerWindowTitle.description")

> **components.GoogleMap.props.markerWindowTitle.description**: `string` = `"The title of the marker window"`

#### components.GoogleMap.props.markerWindowTitle.name[​](#componentsgooglemappropsmarkerwindowtitlename "Direct link to components.GoogleMap.props.markerWindowTitle.name")

> **components.GoogleMap.props.markerWindowTitle.name**: `string` = `"Marker window title"`

#### components.GoogleMap.props.region[​](#componentsgooglemappropsregion "Direct link to components.GoogleMap.props.region")

> **components.GoogleMap.props.region**: `object`

#### components.GoogleMap.props.region.description[​](#componentsgooglemappropsregiondescription "Direct link to components.GoogleMap.props.region.description")

> **components.GoogleMap.props.region.description**: `string` = `"The region code to use"`

#### components.GoogleMap.props.region.name[​](#componentsgooglemappropsregionname "Direct link to components.GoogleMap.props.region.name")

> **components.GoogleMap.props.region.name**: `string` = `"Region"`

#### components.GoogleMap.props.removeMarkerCaption[​](#componentsgooglemappropsremovemarkercaption "Direct link to components.GoogleMap.props.removeMarkerCaption")

> **components.GoogleMap.props.removeMarkerCaption**: `object`

#### components.GoogleMap.props.removeMarkerCaption.description[​](#componentsgooglemappropsremovemarkercaptiondescription "Direct link to components.GoogleMap.props.removeMarkerCaption.description")

> **components.GoogleMap.props.removeMarkerCaption.description**: `string` = `"The caption on the marker removal button"`

#### components.GoogleMap.props.removeMarkerCaption.name[​](#componentsgooglemappropsremovemarkercaptionname "Direct link to components.GoogleMap.props.removeMarkerCaption.name")

> **components.GoogleMap.props.removeMarkerCaption.name**: `string` = `"Remove marker caption"`

#### components.GoogleMap.props.searchPlaceholder[​](#componentsgooglemappropssearchplaceholder "Direct link to components.GoogleMap.props.searchPlaceholder")

> **components.GoogleMap.props.searchPlaceholder**: `object`

#### components.GoogleMap.props.searchPlaceholder.description[​](#componentsgooglemappropssearchplaceholderdescription "Direct link to components.GoogleMap.props.searchPlaceholder.description")

> **components.GoogleMap.props.searchPlaceholder.description**: `string` = `"Placeholder text for the map search input"`

#### components.GoogleMap.props.searchPlaceholder.name[​](#componentsgooglemappropssearchplaceholdername "Direct link to components.GoogleMap.props.searchPlaceholder.name")

> **components.GoogleMap.props.searchPlaceholder.name**: `string` = `"Search placeholder"`

#### components.GoogleMap.props.showMapControl[​](#componentsgooglemappropsshowmapcontrol "Direct link to components.GoogleMap.props.showMapControl")

> **components.GoogleMap.props.showMapControl**: `object`

#### components.GoogleMap.props.showMapControl.description[​](#componentsgooglemappropsshowmapcontroldescription "Direct link to components.GoogleMap.props.showMapControl.description")

> **components.GoogleMap.props.showMapControl.description**: `string` = `"Whether to show the map control"`

#### components.GoogleMap.props.showMapControl.name[​](#componentsgooglemappropsshowmapcontrolname "Direct link to components.GoogleMap.props.showMapControl.name")

> **components.GoogleMap.props.showMapControl.name**: `string` = `"Show map control"`

#### components.GoogleMap.props.width[​](#componentsgooglemappropswidth "Direct link to components.GoogleMap.props.width")

> **components.GoogleMap.props.width**: `object`

#### components.GoogleMap.props.width.description[​](#componentsgooglemappropswidthdescription "Direct link to components.GoogleMap.props.width.description")

> **components.GoogleMap.props.width.description**: `string` = `"Width of the map"`

#### components.GoogleMap.props.width.name[​](#componentsgooglemappropswidthname "Direct link to components.GoogleMap.props.width.name")

> **components.GoogleMap.props.width.name**: `string` = `"Width"`

#### components.GoogleMap.props.zoom[​](#componentsgooglemappropszoom "Direct link to components.GoogleMap.props.zoom")

> **components.GoogleMap.props.zoom**: `object`

#### components.GoogleMap.props.zoom.description[​](#componentsgooglemappropszoomdescription "Direct link to components.GoogleMap.props.zoom.description")

> **components.GoogleMap.props.zoom.description**: `string` = `"Zoom level"`

#### components.GoogleMap.props.zoom.name[​](#componentsgooglemappropszoomname "Direct link to components.GoogleMap.props.zoom.name")

> **components.GoogleMap.props.zoom.name**: `string` = `"Zoom"`


---

# Variable: googleMapModel

> `const` **googleMapModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# @react-form-builder/components-material-ui

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [BreadcrumbsItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem)
* [MuiBoxProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBoxProps)
* [MuiBreadcrumbsItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBreadcrumbsItemProps)
* [MuiBreadcrumbsProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBreadcrumbsProps)
* [MuiCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiCardProps)
* [MuiCheckboxProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiCheckboxProps)
* [MuiContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiContainerProps)
* [MuiDialogProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiDialogProps)
* [MuiFormControlLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiFormControlLabelProps)
* [MuiFormControlProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiFormControlProps)
* [MuiListItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiListItemProps)
* [MuiListProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiListProps)
* [MuiRadioItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiRadioItemProps)
* [MuiSelectProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiSelectProps)
* [MuiStackProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiStackProps)
* [MuiSwitchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiSwitchProps)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

* [MuiTextFieldProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/type-aliases/MuiTextFieldProps)

## Variables[​](#variables "Direct link to Variables")

* [builderView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/builderView)
* [components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/components)
* [materialUiComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/materialUiComponentsDescriptions)
* [models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/models)
* [muiArEgComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiArEgComponentsDescriptions)
* [muiBox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiBox)
* [muiBreadcrumbs](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiBreadcrumbs)
* [muiButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiButton)
* [muiButtonGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiButtonGroup)
* [muiCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiCard)
* [muiCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiCheckbox)
* [muiCircularProgress](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiCircularProgress)
* [muiComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiComponents)
* [muiContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiContainer)
* [muiDeDeComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDeDeComponentsDescriptions)
* [muiDialog](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialog)
* [muiDialogActions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogActions)
* [muiDialogContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogContent)
* [muiDialogContentText](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogContentText)
* [muiDialogLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogLayout)
* [muiDialogTitle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiDialogTitle)
* [muiEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiEnUsComponentsDescriptions)
* [muiErrorWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiErrorWrapper)
* [muiEsEsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiEsEsComponentsDescriptions)
* [muiFaIrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFaIrComponentsDescriptions)
* [muiFormControlLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFormControlLabel)
* [muiFormLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFormLabel)
* [muiFrFrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiFrFrComponentsDescriptions)
* [muiHiInComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiHiInComponentsDescriptions)
* [muiItItComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiItItComponentsDescriptions)
* [muiJaJpComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiJaJpComponentsDescriptions)
* [muiKoKrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiKoKrComponentsDescriptions)
* [muiLinearProgress](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiLinearProgress)
* [muiLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiLink)
* [muiList](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiList)
* [muiListItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiListItem)
* [muiRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiRadioGroup)
* [muiRadioItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiRadioItem)
* [muiSelect](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiSelect)
* [muiSrRsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiSrRsComponentsDescriptions)
* [muiStack](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiStack)
* [muiSwitch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiSwitch)
* [muiTextField](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiTextField)
* [muiTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiTooltip)
* [muiTypography](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiTypography)
* [muiUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiUploader)
* [MuiViewerWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/MuiViewerWrapper)
* [muiZhCnComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/muiZhCnComponentsDescriptions)
* [view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/variables/view)

## Functions[​](#functions "Direct link to Functions")

* [MuiErrorWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/functions/MuiErrorWrapper)


---

# Function: MuiErrorWrapper()

> **MuiErrorWrapper**(`props`): `Element`

A wrapper component for displaying error messages in Material-UI forms.

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)

the properties for the ErrorWrapper component.

## Returns[​](#returns "Direct link to Returns")

`Element`

the React fragment containing the child elements.


---

# Interface: BreadcrumbsItem

Settings for a single breadcrumb item.

## Extended by[​](#extended-by "Direct link to Extended by")

* [`MuiBreadcrumbsItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBreadcrumbsItemProps)

## Properties[​](#properties "Direct link to Properties")

### active?[​](#active "Direct link to active?")

> `optional` **active**: `boolean`

Whether the breadcrumb item is active.

***

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

URL for the breadcrumb item.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

Title text for the breadcrumb item.


---

# Interface: MuiBoxProps

The MuiBox component properties.

## Extends[​](#extends "Direct link to Extends")

* `BoxProps`.`DisabledProps`.`ReadOnlyProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`BoxProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`BoxProps.accessKey`

***

### alignContent?[​](#aligncontent "Direct link to alignContent?")

> `optional` **alignContent**: `ResponsiveStyleValue`\<readonly string\[] | AlignContent | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | AlignContent | undefined>

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`BoxProps.alignContent`

***

### alignItems?[​](#alignitems "Direct link to alignItems?")

> `optional` **alignItems**: `ResponsiveStyleValue`\<readonly string\[] | AlignItems | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | AlignItems | undefined>

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`BoxProps.alignItems`

***

### alignSelf?[​](#alignself "Direct link to alignSelf?")

> `optional` **alignSelf**: `ResponsiveStyleValue`\<readonly string\[] | AlignSelf | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | AlignSelf | undefined>

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`BoxProps.alignSelf`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`BoxProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`BoxProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`BoxProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`BoxProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`BoxProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`BoxProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`BoxProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`BoxProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`BoxProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`BoxProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`BoxProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`BoxProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`BoxProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`BoxProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`BoxProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`BoxProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`BoxProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`BoxProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`BoxProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`BoxProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`BoxProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`BoxProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`BoxProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`BoxProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`BoxProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`BoxProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`BoxProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`BoxProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`BoxProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`BoxProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`BoxProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`BoxProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`BoxProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`BoxProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`BoxProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`BoxProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`BoxProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`BoxProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`BoxProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`BoxProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`BoxProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`BoxProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`BoxProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`BoxProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`BoxProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`BoxProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`BoxProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`BoxProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`BoxProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`BoxProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`BoxProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`BoxProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`BoxProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`BoxProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`BoxProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`BoxProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`BoxProps.autoSave`

***

### bgcolor?[​](#bgcolor "Direct link to bgcolor?")

> `optional` **bgcolor**: `ResponsiveStyleValue`\<readonly string\[] | BackgroundColor | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | BackgroundColor | undefined>

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`BoxProps.bgcolor`

***

### border?[​](#border "Direct link to border?")

> `optional` **border**: `ResponsiveStyleValue`<`undefined` | `number` | `"Menu"` | `"none"` | `"hidden"` | `string` & `object` | `"inset"` | `"red"` | `"-moz-initial"` | `"inherit"` | `"initial"` | `"revert"` | `"revert-layer"` | `"unset"` | `"aliceblue"` | `"antiquewhite"` | `"aqua"` | `"aquamarine"` | `"azure"` | `"beige"` | `"bisque"` | `"black"` | `"blanchedalmond"` | `"blue"` | `"blueviolet"` | `"brown"` | `"burlywood"` | `"cadetblue"` | `"chartreuse"` | `"chocolate"` | `"coral"` | `"cornflowerblue"` | `"cornsilk"` | `"crimson"` | `"cyan"` | `"darkblue"` | `"darkcyan"` | `"darkgoldenrod"` | `"darkgray"` | `"darkgreen"` | `"darkgrey"` | `"darkkhaki"` | `"darkmagenta"` | `"darkolivegreen"` | `"darkorange"` | `"darkorchid"` | `"darkred"` | `"darksalmon"` | `"darkseagreen"` | `"darkslateblue"` | `"darkslategray"` | `"darkslategrey"` | `"darkturquoise"` | `"darkviolet"` | `"deeppink"` | `"deepskyblue"` | `"dimgray"` | `"dimgrey"` | `"dodgerblue"` | `"firebrick"` | `"floralwhite"` | `"forestgreen"` | `"fuchsia"` | `"gainsboro"` | `"ghostwhite"` | `"gold"` | `"goldenrod"` | `"gray"` | `"green"` | `"greenyellow"` | `"grey"` | `"honeydew"` | `"hotpink"` | `"indianred"` | `"indigo"` | `"ivory"` | `"khaki"` | `"lavender"` | `"lavenderblush"` | `"lawngreen"` | `"lemonchiffon"` | `"lightblue"` | `"lightcoral"` | `"lightcyan"` | `"lightgoldenrodyellow"` | `"lightgray"` | `"lightgreen"` | `"lightgrey"` | `"lightpink"` | `"lightsalmon"` | `"lightseagreen"` | `"lightskyblue"` | `"lightslategray"` | `"lightslategrey"` | `"lightsteelblue"` | `"lightyellow"` | `"lime"` | `"limegreen"` | `"linen"` | `"magenta"` | `"maroon"` | `"mediumaquamarine"` | `"mediumblue"` | `"mediumorchid"` | `"mediumpurple"` | `"mediumseagreen"` | `"mediumslateblue"` | `"mediumspringgreen"` | `"mediumturquoise"` | `"mediumvioletred"` | `"midnightblue"` | `"mintcream"` | `"mistyrose"` | `"moccasin"` | `"navajowhite"` | `"navy"` | `"oldlace"` | `"olive"` | `"olivedrab"` | `"orange"` | `"orangered"` | `"orchid"` | `"palegoldenrod"` | `"palegreen"` | `"paleturquoise"` | `"palevioletred"` | `"papayawhip"` | `"peachpuff"` | `"peru"` | `"pink"` | `"plum"` | `"powderblue"` | `"purple"` | `"rebeccapurple"` | `"rosybrown"` | `"royalblue"` | `"saddlebrown"` | `"salmon"` | `"sandybrown"` | `"seagreen"` | `"seashell"` | `"sienna"` | `"silver"` | `"skyblue"` | `"slateblue"` | `"slategray"` | `"slategrey"` | `"snow"` | `"springgreen"` | `"steelblue"` | `"tan"` | `"teal"` | `"thistle"` | `"tomato"` | `"turquoise"` | `"violet"` | `"wheat"` | `"white"` | `"whitesmoke"` | `"yellow"` | `"yellowgreen"` | `"transparent"` | `"AccentColor"` | `"AccentColorText"` | `"ActiveText"` | `"ButtonBorder"` | `"ButtonFace"` | `"ButtonText"` | `"Canvas"` | `"CanvasText"` | `"Field"` | `"FieldText"` | `"GrayText"` | `"Highlight"` | `"HighlightText"` | `"LinkText"` | `"Mark"` | `"MarkText"` | `"SelectedItem"` | `"SelectedItemText"` | `"VisitedText"` | `"ActiveBorder"` | `"ActiveCaption"` | `"AppWorkspace"` | `"Background"` | `"ButtonHighlight"` | `"ButtonShadow"` | `"CaptionText"` | `"InactiveBorder"` | `"InactiveCaption"` | `"InactiveCaptionText"` | `"InfoBackground"` | `"InfoText"` | `"MenuText"` | `"Scrollbar"` | `"ThreeDDarkShadow"` | `"ThreeDFace"` | `"ThreeDHighlight"` | `"ThreeDLightShadow"` | `"ThreeDShadow"` | `"Window"` | `"WindowFrame"` | `"WindowText"` | `"currentColor"` | `"medium"` | `"dashed"` | `"dotted"` | `"double"` | `"groove"` | `"outset"` | `"ridge"` | `"solid"` | `"thick"` | `"thin"`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `number` | `"Menu"` | `"none"` | `"hidden"` | `string` & `object` | `"inset"` | `"red"` | `"-moz-initial"` | `"inherit"` | `"initial"` | `"revert"` | `"revert-layer"` | `"unset"` | `"aliceblue"` | `"antiquewhite"` | `"aqua"` | `"aquamarine"` | `"azure"` | `"beige"` | `"bisque"` | `"black"` | `"blanchedalmond"` | `"blue"` | `"blueviolet"` | `"brown"` | `"burlywood"` | `"cadetblue"` | `"chartreuse"` | `"chocolate"` | `"coral"` | `"cornflowerblue"` | `"cornsilk"` | `"crimson"` | `"cyan"` | `"darkblue"` | `"darkcyan"` | `"darkgoldenrod"` | `"darkgray"` | `"darkgreen"` | `"darkgrey"` | `"darkkhaki"` | `"darkmagenta"` | `"darkolivegreen"` | `"darkorange"` | `"darkorchid"` | `"darkred"` | `"darksalmon"` | `"darkseagreen"` | `"darkslateblue"` | `"darkslategray"` | `"darkslategrey"` | `"darkturquoise"` | `"darkviolet"` | `"deeppink"` | `"deepskyblue"` | `"dimgray"` | `"dimgrey"` | `"dodgerblue"` | `"firebrick"` | `"floralwhite"` | `"forestgreen"` | `"fuchsia"` | `"gainsboro"` | `"ghostwhite"` | `"gold"` | `"goldenrod"` | `"gray"` | `"green"` | `"greenyellow"` | `"grey"` | `"honeydew"` | `"hotpink"` | `"indianred"` | `"indigo"` | `"ivory"` | `"khaki"` | `"lavender"` | `"lavenderblush"` | `"lawngreen"` | `"lemonchiffon"` | `"lightblue"` | `"lightcoral"` | `"lightcyan"` | `"lightgoldenrodyellow"` | `"lightgray"` | `"lightgreen"` | `"lightgrey"` | `"lightpink"` | `"lightsalmon"` | `"lightseagreen"` | `"lightskyblue"` | `"lightslategray"` | `"lightslategrey"` | `"lightsteelblue"` | `"lightyellow"` | `"lime"` | `"limegreen"` | `"linen"` | `"magenta"` | `"maroon"` | `"mediumaquamarine"` | `"mediumblue"` | `"mediumorchid"` | `"mediumpurple"` | `"mediumseagreen"` | `"mediumslateblue"` | `"mediumspringgreen"` | `"mediumturquoise"` | `"mediumvioletred"` | `"midnightblue"` | `"mintcream"` | `"mistyrose"` | `"moccasin"` | `"navajowhite"` | `"navy"` | `"oldlace"` | `"olive"` | `"olivedrab"` | `"orange"` | `"orangered"` | `"orchid"` | `"palegoldenrod"` | `"palegreen"` | `"paleturquoise"` | `"palevioletred"` | `"papayawhip"` | `"peachpuff"` | `"peru"` | `"pink"` | `"plum"` | `"powderblue"` | `"purple"` | `"rebeccapurple"` | `"rosybrown"` | `"royalblue"` | `"saddlebrown"` | `"salmon"` | `"sandybrown"` | `"seagreen"` | `"seashell"` | `"sienna"` | `"silver"` | `"skyblue"` | `"slateblue"` | `"slategray"` | `"slategrey"` | `"snow"` | `"springgreen"` | `"steelblue"` | `"tan"` | `"teal"` | `"thistle"` | `"tomato"` | `"turquoise"` | `"violet"` | `"wheat"` | `"white"` | `"whitesmoke"` | `"yellow"` | `"yellowgreen"` | `"transparent"` | `"AccentColor"` | `"AccentColorText"` | `"ActiveText"` | `"ButtonBorder"` | `"ButtonFace"` | `"ButtonText"` | `"Canvas"` | `"CanvasText"` | `"Field"` | `"FieldText"` | `"GrayText"` | `"Highlight"` | `"HighlightText"` | `"LinkText"` | `"Mark"` | `"MarkText"` | `"SelectedItem"` | `"SelectedItemText"` | `"VisitedText"` | `"ActiveBorder"` | `"ActiveCaption"` | `"AppWorkspace"` | `"Background"` | `"ButtonHighlight"` | `"ButtonShadow"` | `"CaptionText"` | `"InactiveBorder"` | `"InactiveCaption"` | `"InactiveCaptionText"` | `"InfoBackground"` | `"InfoText"` | `"MenuText"` | `"Scrollbar"` | `"ThreeDDarkShadow"` | `"ThreeDFace"` | `"ThreeDHighlight"` | `"ThreeDLightShadow"` | `"ThreeDShadow"` | `"Window"` | `"WindowFrame"` | `"WindowText"` | `"currentColor"` | `"medium"` | `"dashed"` | `"dotted"` | `"double"` | `"groove"` | `"outset"` | `"ridge"` | `"solid"` | `"thick"` | `"thin"`>

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`BoxProps.border`

***

### borderBottom?[​](#borderbottom "Direct link to borderBottom?")

> `optional` **borderBottom**: `ResponsiveStyleValue`\<BorderBottom\<string | number> | readonly NonNullable\<BorderBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderBottom\<string | number> | readonly NonNullable\<BorderBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`BoxProps.borderBottom`

***

### borderColor?[​](#bordercolor "Direct link to borderColor?")

> `optional` **borderColor**: `ResponsiveStyleValue`\<readonly string\[] | BorderColor | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | BorderColor | undefined>

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`BoxProps.borderColor`

***

### borderLeft?[​](#borderleft "Direct link to borderLeft?")

> `optional` **borderLeft**: `ResponsiveStyleValue`\<BorderLeft\<string | number> | readonly NonNullable\<BorderLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderLeft\<string | number> | readonly NonNullable\<BorderLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`BoxProps.borderLeft`

***

### borderRadius?[​](#borderradius "Direct link to borderRadius?")

> `optional` **borderRadius**: `ResponsiveStyleValue`\<BorderRadius\<string | number> | readonly NonNullable\<BorderRadius\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderRadius\<string | number> | readonly NonNullable\<BorderRadius\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`BoxProps.borderRadius`

***

### borderRight?[​](#borderright "Direct link to borderRight?")

> `optional` **borderRight**: `ResponsiveStyleValue`\<BorderRight\<string | number> | readonly NonNullable\<BorderRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderRight\<string | number> | readonly NonNullable\<BorderRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`BoxProps.borderRight`

***

### borderTop?[​](#bordertop "Direct link to borderTop?")

> `optional` **borderTop**: `ResponsiveStyleValue`\<BorderTop\<string | number> | readonly NonNullable\<BorderTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderTop\<string | number> | readonly NonNullable\<BorderTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`BoxProps.borderTop`

***

### bottom?[​](#bottom "Direct link to bottom?")

> `optional` **bottom**: `ResponsiveStyleValue`\<Bottom\<string | number> | readonly NonNullable\<Bottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Bottom\<string | number> | readonly NonNullable\<Bottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`BoxProps.bottom`

***

### boxShadow?[​](#boxshadow "Direct link to boxShadow?")

> `optional` **boxShadow**: `ResponsiveStyleValue`\<number | BoxShadow | undefined> | (`theme`) => `ResponsiveStyleValue`\<number | BoxShadow | undefined>

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`BoxProps.boxShadow`

***

### boxSizing?[​](#boxsizing "Direct link to boxSizing?")

> `optional` **boxSizing**: `ResponsiveStyleValue`\<BoxSizing | readonly NonNullable\<BoxSizing | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BoxSizing | readonly NonNullable\<BoxSizing | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`BoxProps.boxSizing`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`BoxProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`BoxProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`BoxProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `ResponsiveStyleValue`\<readonly string\[] | Color | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Color | undefined>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`BoxProps.color`

***

### columnGap?[​](#columngap "Direct link to columnGap?")

> `optional` **columnGap**: `ResponsiveStyleValue`\<ColumnGap\<string | number> | readonly NonNullable\<ColumnGap\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<ColumnGap\<string | number> | readonly NonNullable\<ColumnGap\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`BoxProps.columnGap`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`BoxProps.component`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`BoxProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`BoxProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`BoxProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`BoxProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`BoxProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`BoxProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`BoxProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`BoxProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the component will be disabled.

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`DisabledProps.disabled`

***

### display?[​](#display "Direct link to display?")

> `optional` **display**: `ResponsiveStyleValue`\<readonly string\[] | Display | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Display | undefined>

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`BoxProps.display`

***

### displayPrint?[​](#displayprint "Direct link to displayPrint?")

> `optional` **displayPrint**: `ResponsiveStyleValue`\<readonly string\[] | Display | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Display | undefined>

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`BoxProps.displayPrint`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`BoxProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`BoxProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`BoxProps.exportparts`

***

### flex?[​](#flex "Direct link to flex?")

> `optional` **flex**: `ResponsiveStyleValue`\<Flex\<string | number> | readonly NonNullable\<Flex\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Flex\<string | number> | readonly NonNullable\<Flex\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`BoxProps.flex`

***

### flexBasis?[​](#flexbasis "Direct link to flexBasis?")

> `optional` **flexBasis**: `ResponsiveStyleValue`\<FlexBasis\<string | number> | readonly NonNullable\<FlexBasis\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexBasis\<string | number> | readonly NonNullable\<FlexBasis\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`BoxProps.flexBasis`

***

### flexDirection?[​](#flexdirection "Direct link to flexDirection?")

> `optional` **flexDirection**: `ResponsiveStyleValue`\<FlexDirection | readonly NonNullable\<FlexDirection | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexDirection | readonly NonNullable\<FlexDirection | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`BoxProps.flexDirection`

***

### flexGrow?[​](#flexgrow "Direct link to flexGrow?")

> `optional` **flexGrow**: `ResponsiveStyleValue`\<FlexGrow | readonly NonNullable\<FlexGrow | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexGrow | readonly NonNullable\<FlexGrow | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`BoxProps.flexGrow`

***

### flexShrink?[​](#flexshrink "Direct link to flexShrink?")

> `optional` **flexShrink**: `ResponsiveStyleValue`\<FlexShrink | readonly NonNullable\<FlexShrink | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexShrink | readonly NonNullable\<FlexShrink | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`BoxProps.flexShrink`

***

### flexWrap?[​](#flexwrap "Direct link to flexWrap?")

> `optional` **flexWrap**: `ResponsiveStyleValue`\<FlexWrap | readonly NonNullable\<FlexWrap | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexWrap | readonly NonNullable\<FlexWrap | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`BoxProps.flexWrap`

***

### fontFamily?[​](#fontfamily "Direct link to fontFamily?")

> `optional` **fontFamily**: `ResponsiveStyleValue`\<readonly string\[] | FontFamily | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | FontFamily | undefined>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`BoxProps.fontFamily`

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `ResponsiveStyleValue`\<FontSize\<string | number> | readonly NonNullable\<FontSize\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FontSize\<string | number> | readonly NonNullable\<FontSize\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`BoxProps.fontSize`

***

### fontStyle?[​](#fontstyle "Direct link to fontStyle?")

> `optional` **fontStyle**: `ResponsiveStyleValue`\<readonly string\[] | FontStyle | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | FontStyle | undefined>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`BoxProps.fontStyle`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`BoxProps.fontWeight`

***

### gap?[​](#gap "Direct link to gap?")

> `optional` **gap**: `ResponsiveStyleValue`\<Gap\<string | number> | readonly NonNullable\<Gap\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Gap\<string | number> | readonly NonNullable\<Gap\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`BoxProps.gap`

***

### gridArea?[​](#gridarea "Direct link to gridArea?")

> `optional` **gridArea**: `ResponsiveStyleValue`\<GridArea | readonly NonNullable\<GridArea | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridArea | readonly NonNullable\<GridArea | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`BoxProps.gridArea`

***

### gridAutoColumns?[​](#gridautocolumns "Direct link to gridAutoColumns?")

> `optional` **gridAutoColumns**: `ResponsiveStyleValue`\<GridAutoColumns\<string | number> | readonly NonNullable\<GridAutoColumns\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridAutoColumns\<string | number> | readonly NonNullable\<GridAutoColumns\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`BoxProps.gridAutoColumns`

***

### gridAutoFlow?[​](#gridautoflow "Direct link to gridAutoFlow?")

> `optional` **gridAutoFlow**: `ResponsiveStyleValue`\<readonly string\[] | GridAutoFlow | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | GridAutoFlow | undefined>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`BoxProps.gridAutoFlow`

***

### gridAutoRows?[​](#gridautorows "Direct link to gridAutoRows?")

> `optional` **gridAutoRows**: `ResponsiveStyleValue`\<GridAutoRows\<string | number> | readonly NonNullable\<GridAutoRows\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridAutoRows\<string | number> | readonly NonNullable\<GridAutoRows\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`BoxProps.gridAutoRows`

***

### gridColumn?[​](#gridcolumn "Direct link to gridColumn?")

> `optional` **gridColumn**: `ResponsiveStyleValue`\<GridColumn | readonly NonNullable\<GridColumn | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridColumn | readonly NonNullable\<GridColumn | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`BoxProps.gridColumn`

***

### gridRow?[​](#gridrow "Direct link to gridRow?")

> `optional` **gridRow**: `ResponsiveStyleValue`\<GridRow | readonly NonNullable\<GridRow | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridRow | readonly NonNullable\<GridRow | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`BoxProps.gridRow`

***

### gridTemplateAreas?[​](#gridtemplateareas "Direct link to gridTemplateAreas?")

> `optional` **gridTemplateAreas**: `ResponsiveStyleValue`\<readonly string\[] | GridTemplateAreas | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | GridTemplateAreas | undefined>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`BoxProps.gridTemplateAreas`

***

### gridTemplateColumns?[​](#gridtemplatecolumns "Direct link to gridTemplateColumns?")

> `optional` **gridTemplateColumns**: `ResponsiveStyleValue`\<GridTemplateColumns\<string | number> | readonly NonNullable\<GridTemplateColumns\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridTemplateColumns\<string | number> | readonly NonNullable\<GridTemplateColumns\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`BoxProps.gridTemplateColumns`

***

### gridTemplateRows?[​](#gridtemplaterows "Direct link to gridTemplateRows?")

> `optional` **gridTemplateRows**: `ResponsiveStyleValue`\<GridTemplateRows\<string | number> | readonly NonNullable\<GridTemplateRows\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridTemplateRows\<string | number> | readonly NonNullable\<GridTemplateRows\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`BoxProps.gridTemplateRows`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `ResponsiveStyleValue`\<Height\<string | number> | readonly NonNullable\<Height\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Height\<string | number> | readonly NonNullable\<Height\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`BoxProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`BoxProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`BoxProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`BoxProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`BoxProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`BoxProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`BoxProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`BoxProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`BoxProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`BoxProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`BoxProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`BoxProps.itemType`

***

### justifyContent?[​](#justifycontent "Direct link to justifyContent?")

> `optional` **justifyContent**: `ResponsiveStyleValue`\<readonly string\[] | JustifyContent | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | JustifyContent | undefined>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`BoxProps.justifyContent`

***

### justifyItems?[​](#justifyitems "Direct link to justifyItems?")

> `optional` **justifyItems**: `ResponsiveStyleValue`\<readonly string\[] | JustifyItems | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | JustifyItems | undefined>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`BoxProps.justifyItems`

***

### justifySelf?[​](#justifyself "Direct link to justifySelf?")

> `optional` **justifySelf**: `ResponsiveStyleValue`\<readonly string\[] | JustifySelf | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | JustifySelf | undefined>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`BoxProps.justifySelf`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`BoxProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`BoxProps.lang`

***

### left?[​](#left "Direct link to left?")

> `optional` **left**: `ResponsiveStyleValue`\<Left\<string | number> | readonly NonNullable\<Left\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Left\<string | number> | readonly NonNullable\<Left\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`BoxProps.left`

***

### letterSpacing?[​](#letterspacing "Direct link to letterSpacing?")

> `optional` **letterSpacing**: `ResponsiveStyleValue`\<LetterSpacing\<string | number> | readonly NonNullable\<LetterSpacing\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<LetterSpacing\<string | number> | readonly NonNullable\<LetterSpacing\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`BoxProps.letterSpacing`

***

### lineHeight?[​](#lineheight "Direct link to lineHeight?")

> `optional` **lineHeight**: `ResponsiveStyleValue`\<LineHeight\<string | number> | readonly NonNullable\<LineHeight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<LineHeight\<string | number> | readonly NonNullable\<LineHeight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`BoxProps.lineHeight`

***

### m?[​](#m "Direct link to m?")

> `optional` **m**: `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`BoxProps.m`

***

### margin?[​](#margin "Direct link to margin?")

> `optional` **margin**: `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`BoxProps.margin`

***

### marginBlock?[​](#marginblock "Direct link to marginBlock?")

> `optional` **marginBlock**: `ResponsiveStyleValue`\<MarginBlock\<string | number> | readonly NonNullable\<MarginBlock\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBlock\<string | number> | readonly NonNullable\<MarginBlock\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`BoxProps.marginBlock`

***

### marginBlockEnd?[​](#marginblockend "Direct link to marginBlockEnd?")

> `optional` **marginBlockEnd**: `ResponsiveStyleValue`\<MarginBlockEnd\<string | number> | readonly NonNullable\<MarginBlockEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBlockEnd\<string | number> | readonly NonNullable\<MarginBlockEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`BoxProps.marginBlockEnd`

***

### marginBlockStart?[​](#marginblockstart "Direct link to marginBlockStart?")

> `optional` **marginBlockStart**: `ResponsiveStyleValue`\<MarginBlockStart\<string | number> | readonly NonNullable\<MarginBlockStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBlockStart\<string | number> | readonly NonNullable\<MarginBlockStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`BoxProps.marginBlockStart`

***

### marginBottom?[​](#marginbottom "Direct link to marginBottom?")

> `optional` **marginBottom**: `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`BoxProps.marginBottom`

***

### marginInline?[​](#margininline "Direct link to marginInline?")

> `optional` **marginInline**: `ResponsiveStyleValue`\<MarginInline\<string | number> | readonly NonNullable\<MarginInline\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginInline\<string | number> | readonly NonNullable\<MarginInline\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`BoxProps.marginInline`

***

### marginInlineEnd?[​](#margininlineend "Direct link to marginInlineEnd?")

> `optional` **marginInlineEnd**: `ResponsiveStyleValue`\<MarginInlineEnd\<string | number> | readonly NonNullable\<MarginInlineEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginInlineEnd\<string | number> | readonly NonNullable\<MarginInlineEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`BoxProps.marginInlineEnd`

***

### marginInlineStart?[​](#margininlinestart "Direct link to marginInlineStart?")

> `optional` **marginInlineStart**: `ResponsiveStyleValue`\<MarginInlineStart\<string | number> | readonly NonNullable\<MarginInlineStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginInlineStart\<string | number> | readonly NonNullable\<MarginInlineStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`BoxProps.marginInlineStart`

***

### marginLeft?[​](#marginleft "Direct link to marginLeft?")

> `optional` **marginLeft**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`BoxProps.marginLeft`

***

### marginRight?[​](#marginright "Direct link to marginRight?")

> `optional` **marginRight**: `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`BoxProps.marginRight`

***

### marginTop?[​](#margintop "Direct link to marginTop?")

> `optional` **marginTop**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`BoxProps.marginTop`

***

### marginX?[​](#marginx "Direct link to marginX?")

> `optional` **marginX**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`BoxProps.marginX`

***

### marginY?[​](#marginy "Direct link to marginY?")

> `optional` **marginY**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`BoxProps.marginY`

***

### maxHeight?[​](#maxheight "Direct link to maxHeight?")

> `optional` **maxHeight**: `ResponsiveStyleValue`\<MaxHeight\<string | number> | readonly NonNullable\<MaxHeight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MaxHeight\<string | number> | readonly NonNullable\<MaxHeight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`BoxProps.maxHeight`

***

### maxWidth?[​](#maxwidth "Direct link to maxWidth?")

> `optional` **maxWidth**: `ResponsiveStyleValue`\<MaxWidth\<string | number> | readonly NonNullable\<MaxWidth\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MaxWidth\<string | number> | readonly NonNullable\<MaxWidth\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`BoxProps.maxWidth`

***

### mb?[​](#mb "Direct link to mb?")

> `optional` **mb**: `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`BoxProps.mb`

***

### minHeight?[​](#minheight "Direct link to minHeight?")

> `optional` **minHeight**: `ResponsiveStyleValue`\<MinHeight\<string | number> | readonly NonNullable\<MinHeight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MinHeight\<string | number> | readonly NonNullable\<MinHeight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`BoxProps.minHeight`

***

### minWidth?[​](#minwidth "Direct link to minWidth?")

> `optional` **minWidth**: `ResponsiveStyleValue`\<MinWidth\<string | number> | readonly NonNullable\<MinWidth\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MinWidth\<string | number> | readonly NonNullable\<MinWidth\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`BoxProps.minWidth`

***

### ml?[​](#ml "Direct link to ml?")

> `optional` **ml**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`BoxProps.ml`

***

### mr?[​](#mr "Direct link to mr?")

> `optional` **mr**: `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`BoxProps.mr`

***

### mt?[​](#mt "Direct link to mt?")

> `optional` **mt**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`BoxProps.mt`

***

### mx?[​](#mx "Direct link to mx?")

> `optional` **mx**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`BoxProps.mx`

***

### my?[​](#my "Direct link to my?")

> `optional` **my**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`BoxProps.my`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`BoxProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`BoxProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`BoxProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`BoxProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`BoxProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`BoxProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`BoxProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`BoxProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`BoxProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`BoxProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`BoxProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`BoxProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`BoxProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`BoxProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`BoxProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`BoxProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`BoxProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`BoxProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`BoxProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`BoxProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`BoxProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`BoxProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`BoxProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`BoxProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`BoxProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`BoxProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`BoxProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`BoxProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`BoxProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`BoxProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`BoxProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`BoxProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`BoxProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`BoxProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`BoxProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`BoxProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`BoxProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`BoxProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`BoxProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`BoxProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`BoxProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`BoxProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`BoxProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`BoxProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`BoxProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`BoxProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`BoxProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`BoxProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`BoxProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`BoxProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`BoxProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`BoxProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`BoxProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`BoxProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`BoxProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`BoxProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`BoxProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`BoxProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`BoxProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`BoxProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`BoxProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`BoxProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`BoxProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`BoxProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`BoxProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`BoxProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`BoxProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`BoxProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`BoxProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`BoxProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`BoxProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`BoxProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`BoxProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`BoxProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`BoxProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`BoxProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`BoxProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`BoxProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`BoxProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`BoxProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`BoxProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`BoxProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`BoxProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`BoxProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`BoxProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`BoxProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`BoxProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`BoxProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`BoxProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`BoxProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`BoxProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`BoxProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`BoxProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`BoxProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`BoxProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`BoxProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`BoxProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`BoxProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`BoxProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`BoxProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`BoxProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`BoxProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`BoxProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`BoxProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`BoxProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`BoxProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`BoxProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`BoxProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`BoxProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`BoxProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`BoxProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`BoxProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`BoxProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`BoxProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`BoxProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`BoxProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`BoxProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`BoxProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`BoxProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`BoxProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`BoxProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`BoxProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`BoxProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`BoxProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`BoxProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`BoxProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`BoxProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`BoxProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`BoxProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`BoxProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`BoxProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`BoxProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`BoxProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`BoxProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`BoxProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`BoxProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`BoxProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`BoxProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`BoxProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`BoxProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`BoxProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`BoxProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`BoxProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`BoxProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`BoxProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`BoxProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`BoxProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`BoxProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`BoxProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`BoxProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`BoxProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`BoxProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`BoxProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`BoxProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`BoxProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`BoxProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`BoxProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`BoxProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`BoxProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`BoxProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`BoxProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`BoxProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`BoxProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`BoxProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`BoxProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-322 "Direct link to Inherited from")

`BoxProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-323 "Direct link to Inherited from")

`BoxProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-324 "Direct link to Inherited from")

`BoxProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-325 "Direct link to Inherited from")

`BoxProps.onWheelCapture`

***

### order?[​](#order "Direct link to order?")

> `optional` **order**: `ResponsiveStyleValue`\<Order | readonly NonNullable\<Order | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Order | readonly NonNullable\<Order | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-326 "Direct link to Inherited from")

`BoxProps.order`

***

### overflow?[​](#overflow "Direct link to overflow?")

> `optional` **overflow**: `ResponsiveStyleValue`\<readonly string\[] | Overflow | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Overflow | undefined>

#### Inherited from[​](#inherited-from-327 "Direct link to Inherited from")

`BoxProps.overflow`

***

### p?[​](#p "Direct link to p?")

> `optional` **p**: `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-328 "Direct link to Inherited from")

`BoxProps.p`

***

### padding?[​](#padding "Direct link to padding?")

> `optional` **padding**: `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-329 "Direct link to Inherited from")

`BoxProps.padding`

***

### paddingBlock?[​](#paddingblock "Direct link to paddingBlock?")

> `optional` **paddingBlock**: `ResponsiveStyleValue`\<PaddingBlock\<string | number> | readonly NonNullable\<PaddingBlock\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBlock\<string | number> | readonly NonNullable\<PaddingBlock\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-330 "Direct link to Inherited from")

`BoxProps.paddingBlock`

***

### paddingBlockEnd?[​](#paddingblockend "Direct link to paddingBlockEnd?")

> `optional` **paddingBlockEnd**: `ResponsiveStyleValue`\<PaddingBlockEnd\<string | number> | readonly NonNullable\<PaddingBlockEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBlockEnd\<string | number> | readonly NonNullable\<PaddingBlockEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-331 "Direct link to Inherited from")

`BoxProps.paddingBlockEnd`

***

### paddingBlockStart?[​](#paddingblockstart "Direct link to paddingBlockStart?")

> `optional` **paddingBlockStart**: `ResponsiveStyleValue`\<PaddingBlockStart\<string | number> | readonly NonNullable\<PaddingBlockStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBlockStart\<string | number> | readonly NonNullable\<PaddingBlockStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-332 "Direct link to Inherited from")

`BoxProps.paddingBlockStart`

***

### paddingBottom?[​](#paddingbottom "Direct link to paddingBottom?")

> `optional` **paddingBottom**: `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-333 "Direct link to Inherited from")

`BoxProps.paddingBottom`

***

### paddingInline?[​](#paddinginline "Direct link to paddingInline?")

> `optional` **paddingInline**: `ResponsiveStyleValue`\<PaddingInline\<string | number> | readonly NonNullable\<PaddingInline\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingInline\<string | number> | readonly NonNullable\<PaddingInline\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-334 "Direct link to Inherited from")

`BoxProps.paddingInline`

***

### paddingInlineEnd?[​](#paddinginlineend "Direct link to paddingInlineEnd?")

> `optional` **paddingInlineEnd**: `ResponsiveStyleValue`\<PaddingInlineEnd\<string | number> | readonly NonNullable\<PaddingInlineEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingInlineEnd\<string | number> | readonly NonNullable\<PaddingInlineEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-335 "Direct link to Inherited from")

`BoxProps.paddingInlineEnd`

***

### paddingInlineStart?[​](#paddinginlinestart "Direct link to paddingInlineStart?")

> `optional` **paddingInlineStart**: `ResponsiveStyleValue`\<PaddingInlineStart\<string | number> | readonly NonNullable\<PaddingInlineStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingInlineStart\<string | number> | readonly NonNullable\<PaddingInlineStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-336 "Direct link to Inherited from")

`BoxProps.paddingInlineStart`

***

### paddingLeft?[​](#paddingleft "Direct link to paddingLeft?")

> `optional` **paddingLeft**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-337 "Direct link to Inherited from")

`BoxProps.paddingLeft`

***

### paddingRight?[​](#paddingright "Direct link to paddingRight?")

> `optional` **paddingRight**: `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-338 "Direct link to Inherited from")

`BoxProps.paddingRight`

***

### paddingTop?[​](#paddingtop "Direct link to paddingTop?")

> `optional` **paddingTop**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-339 "Direct link to Inherited from")

`BoxProps.paddingTop`

***

### paddingX?[​](#paddingx "Direct link to paddingX?")

> `optional` **paddingX**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-340 "Direct link to Inherited from")

`BoxProps.paddingX`

***

### paddingY?[​](#paddingy "Direct link to paddingY?")

> `optional` **paddingY**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-341 "Direct link to Inherited from")

`BoxProps.paddingY`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-342 "Direct link to Inherited from")

`BoxProps.part`

***

### pb?[​](#pb "Direct link to pb?")

> `optional` **pb**: `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-343 "Direct link to Inherited from")

`BoxProps.pb`

***

### pl?[​](#pl "Direct link to pl?")

> `optional` **pl**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-344 "Direct link to Inherited from")

`BoxProps.pl`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-345 "Direct link to Inherited from")

`BoxProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-346 "Direct link to Inherited from")

`BoxProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-347 "Direct link to Inherited from")

`BoxProps.popoverTargetAction`

***

### position?[​](#position "Direct link to position?")

> `optional` **position**: `ResponsiveStyleValue`\<Position | readonly NonNullable\<Position | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Position | readonly NonNullable\<Position | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-348 "Direct link to Inherited from")

`BoxProps.position`

***

### pr?[​](#pr "Direct link to pr?")

> `optional` **pr**: `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-349 "Direct link to Inherited from")

`BoxProps.pr`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-350 "Direct link to Inherited from")

`BoxProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-351 "Direct link to Inherited from")

`BoxProps.property`

***

### pt?[​](#pt "Direct link to pt?")

> `optional` **pt**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-352 "Direct link to Inherited from")

`BoxProps.pt`

***

### px?[​](#px "Direct link to px?")

> `optional` **px**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-353 "Direct link to Inherited from")

`BoxProps.px`

***

### py?[​](#py "Direct link to py?")

> `optional` **py**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-354 "Direct link to Inherited from")

`BoxProps.py`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-355 "Direct link to Inherited from")

`BoxProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the component will be read-only.

#### Inherited from[​](#inherited-from-356 "Direct link to Inherited from")

`ReadOnlyProps.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`unknown`>

#### Inherited from[​](#inherited-from-357 "Direct link to Inherited from")

`BoxProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-358 "Direct link to Inherited from")

`BoxProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-359 "Direct link to Inherited from")

`BoxProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-360 "Direct link to Inherited from")

`BoxProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-361 "Direct link to Inherited from")

`BoxProps.rev`

***

### right?[​](#right "Direct link to right?")

> `optional` **right**: `ResponsiveStyleValue`\<Right\<string | number> | readonly NonNullable\<Right\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Right\<string | number> | readonly NonNullable\<Right\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-362 "Direct link to Inherited from")

`BoxProps.right`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-363 "Direct link to Inherited from")

`BoxProps.role`

***

### rowGap?[​](#rowgap "Direct link to rowGap?")

> `optional` **rowGap**: `ResponsiveStyleValue`\<RowGap\<string | number> | readonly NonNullable\<RowGap\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<RowGap\<string | number> | readonly NonNullable\<RowGap\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-364 "Direct link to Inherited from")

`BoxProps.rowGap`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-365 "Direct link to Inherited from")

`BoxProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-366 "Direct link to Inherited from")

`BoxProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-367 "Direct link to Inherited from")

`BoxProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-368 "Direct link to Inherited from")

`BoxProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-369 "Direct link to Inherited from")

`BoxProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-370 "Direct link to Inherited from")

`BoxProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-371 "Direct link to Inherited from")

`BoxProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-372 "Direct link to Inherited from")

`BoxProps.tabIndex`

***

### textAlign?[​](#textalign "Direct link to textAlign?")

> `optional` **textAlign**: `ResponsiveStyleValue`\<TextAlign | readonly NonNullable\<TextAlign | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<TextAlign | readonly NonNullable\<TextAlign | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-373 "Direct link to Inherited from")

`BoxProps.textAlign`

***

### textOverflow?[​](#textoverflow "Direct link to textOverflow?")

> `optional` **textOverflow**: `ResponsiveStyleValue`\<readonly string\[] | TextOverflow | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | TextOverflow | undefined>

#### Inherited from[​](#inherited-from-374 "Direct link to Inherited from")

`BoxProps.textOverflow`

***

### textTransform?[​](#texttransform "Direct link to textTransform?")

> `optional` **textTransform**: `ResponsiveStyleValue`\<readonly string\[] | TextTransform | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | TextTransform | undefined>

#### Inherited from[​](#inherited-from-375 "Direct link to Inherited from")

`BoxProps.textTransform`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-376 "Direct link to Inherited from")

`BoxProps.title`

***

### top?[​](#top "Direct link to top?")

> `optional` **top**: `ResponsiveStyleValue`\<Top\<string | number> | readonly NonNullable\<Top\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Top\<string | number> | readonly NonNullable\<Top\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-377 "Direct link to Inherited from")

`BoxProps.top`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-378 "Direct link to Inherited from")

`BoxProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-379 "Direct link to Inherited from")

`BoxProps.typeof`

***

### typography?[​](#typography "Direct link to typography?")

> `optional` **typography**: `ResponsiveStyleValue`<`undefined` | `string`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `string`>

#### Inherited from[​](#inherited-from-380 "Direct link to Inherited from")

`BoxProps.typography`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-381 "Direct link to Inherited from")

`BoxProps.unselectable`

***

### visibility?[​](#visibility "Direct link to visibility?")

> `optional` **visibility**: `ResponsiveStyleValue`\<Visibility | readonly NonNullable\<Visibility | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Visibility | readonly NonNullable\<Visibility | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-382 "Direct link to Inherited from")

`BoxProps.visibility`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-383 "Direct link to Inherited from")

`BoxProps.vocab`

***

### whiteSpace?[​](#whitespace "Direct link to whiteSpace?")

> `optional` **whiteSpace**: `ResponsiveStyleValue`\<readonly string\[] | WhiteSpace | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | WhiteSpace | undefined>

#### Inherited from[​](#inherited-from-384 "Direct link to Inherited from")

`BoxProps.whiteSpace`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `ResponsiveStyleValue`\<Width\<string | number> | readonly NonNullable\<Width\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Width\<string | number> | readonly NonNullable\<Width\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-385 "Direct link to Inherited from")

`BoxProps.width`

***

### zIndex?[​](#zindex "Direct link to zIndex?")

> `optional` **zIndex**: `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`>

#### Inherited from[​](#inherited-from-386 "Direct link to Inherited from")

`BoxProps.zIndex`


---

# Interface: MuiBreadcrumbsItemProps

Props for a single breadcrumb item component.

## Extends[​](#extends "Direct link to Extends")

* [`BreadcrumbsItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem)

## Properties[​](#properties "Direct link to Properties")

### active?[​](#active "Direct link to active?")

> `optional` **active**: `boolean`

Whether the breadcrumb item is active.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`BreadcrumbsItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem).[`active`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem#active)

***

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

URL for the breadcrumb item.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`BreadcrumbsItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem).[`href`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem#href)

***

### onClick()?[​](#onclick "Direct link to onClick()?")

> `optional` **onClick**: (`item`) => `void`

Callback function when the breadcrumb item is clicked.

#### Parameters[​](#parameters "Direct link to Parameters")

##### item[​](#item "Direct link to item")

[`BreadcrumbsItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem)

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

Title text for the breadcrumb item.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`BreadcrumbsItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem).[`title`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem#title)


---

# Interface: MuiBreadcrumbsProps

Props for the MuiBreadcrumbs component.

## Extends[​](#extends "Direct link to Extends")

* `BreadcrumbsProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`BreadcrumbsProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`BreadcrumbsProps.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`BreadcrumbsProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`BreadcrumbsProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`BreadcrumbsProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`BreadcrumbsProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`BreadcrumbsProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`BreadcrumbsProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`BreadcrumbsProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`BreadcrumbsProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`BreadcrumbsProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`BreadcrumbsProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`BreadcrumbsProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`BreadcrumbsProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`BreadcrumbsProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`BreadcrumbsProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`BreadcrumbsProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`BreadcrumbsProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`BreadcrumbsProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`BreadcrumbsProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`BreadcrumbsProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`BreadcrumbsProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`BreadcrumbsProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`BreadcrumbsProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`BreadcrumbsProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`BreadcrumbsProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`BreadcrumbsProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`BreadcrumbsProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`BreadcrumbsProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`BreadcrumbsProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`BreadcrumbsProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`BreadcrumbsProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`BreadcrumbsProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`BreadcrumbsProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`BreadcrumbsProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`BreadcrumbsProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`BreadcrumbsProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`BreadcrumbsProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`BreadcrumbsProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`BreadcrumbsProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`BreadcrumbsProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`BreadcrumbsProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`BreadcrumbsProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`BreadcrumbsProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`BreadcrumbsProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`BreadcrumbsProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`BreadcrumbsProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`BreadcrumbsProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`BreadcrumbsProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`BreadcrumbsProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`BreadcrumbsProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`BreadcrumbsProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`BreadcrumbsProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`BreadcrumbsProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`BreadcrumbsProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`BreadcrumbsProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`BreadcrumbsProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`BreadcrumbsProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`BreadcrumbsProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The content of the component.

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`BreadcrumbsProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`BreadcrumbsClasses`> & `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`BreadcrumbsProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`BreadcrumbsProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`BreadcrumbsProps.color`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`BreadcrumbsProps.component`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`BreadcrumbsProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`BreadcrumbsProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`BreadcrumbsProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`BreadcrumbsProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`BreadcrumbsProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`BreadcrumbsProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`BreadcrumbsProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`BreadcrumbsProps.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`BreadcrumbsProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`BreadcrumbsProps.enterKeyHint`

***

### expandText?[​](#expandtext "Direct link to expandText?")

> `optional` **expandText**: `string`

Override the default label for the expand button.

For localization purposes, you can use the provided [translations](https://mui.com/material-ui/guides/localization/).

#### Default[​](#default "Direct link to Default")

```
'Show path'
```

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`BreadcrumbsProps.expandText`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`BreadcrumbsProps.exportparts`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`BreadcrumbsProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`BreadcrumbsProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`BreadcrumbsProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`BreadcrumbsProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`BreadcrumbsProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`BreadcrumbsProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`BreadcrumbsProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`BreadcrumbsProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`BreadcrumbsProps.itemRef`

***

### items[​](#items "Direct link to items")

> **items**: [`BreadcrumbsItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/BreadcrumbsItem)\[]

Array of breadcrumb items to display.

***

### itemsAfterCollapse?[​](#itemsaftercollapse "Direct link to itemsAfterCollapse?")

> `optional` **itemsAfterCollapse**: `number`

If max items is exceeded, the number of items to show after the ellipsis.

#### Default[​](#default-1 "Direct link to Default")

```
1
```

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`BreadcrumbsProps.itemsAfterCollapse`

***

### itemsBeforeCollapse?[​](#itemsbeforecollapse "Direct link to itemsBeforeCollapse?")

> `optional` **itemsBeforeCollapse**: `number`

If max items is exceeded, the number of items to show before the ellipsis.

#### Default[​](#default-2 "Direct link to Default")

```
1
```

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`BreadcrumbsProps.itemsBeforeCollapse`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`BreadcrumbsProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`BreadcrumbsProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`BreadcrumbsProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`BreadcrumbsProps.lang`

***

### maxItems?[​](#maxitems "Direct link to maxItems?")

> `optional` **maxItems**: `number`

Specifies the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first `itemsBeforeCollapse` and last `itemsAfterCollapse` will be shown, with an ellipsis in between.

#### Default[​](#default-3 "Direct link to Default")

```
8
```

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`BreadcrumbsProps.maxItems`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`BreadcrumbsProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`BreadcrumbsProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`BreadcrumbsProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`BreadcrumbsProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`BreadcrumbsProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`BreadcrumbsProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`BreadcrumbsProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`BreadcrumbsProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`BreadcrumbsProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`BreadcrumbsProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`BreadcrumbsProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`BreadcrumbsProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`BreadcrumbsProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`BreadcrumbsProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`BreadcrumbsProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`BreadcrumbsProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`BreadcrumbsProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`BreadcrumbsProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`BreadcrumbsProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`BreadcrumbsProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`BreadcrumbsProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`BreadcrumbsProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`BreadcrumbsProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`BreadcrumbsProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`BreadcrumbsProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`BreadcrumbsProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`BreadcrumbsProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`BreadcrumbsProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`BreadcrumbsProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`BreadcrumbsProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`BreadcrumbsProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`BreadcrumbsProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`BreadcrumbsProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`BreadcrumbsProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`BreadcrumbsProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`BreadcrumbsProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`BreadcrumbsProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`BreadcrumbsProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`BreadcrumbsProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`BreadcrumbsProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`BreadcrumbsProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`BreadcrumbsProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`BreadcrumbsProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`BreadcrumbsProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`BreadcrumbsProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`BreadcrumbsProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`BreadcrumbsProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`BreadcrumbsProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`BreadcrumbsProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`BreadcrumbsProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`BreadcrumbsProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`BreadcrumbsProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`BreadcrumbsProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`BreadcrumbsProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`BreadcrumbsProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`BreadcrumbsProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`BreadcrumbsProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`BreadcrumbsProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`BreadcrumbsProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`BreadcrumbsProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`BreadcrumbsProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`BreadcrumbsProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`BreadcrumbsProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`BreadcrumbsProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`BreadcrumbsProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`BreadcrumbsProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`BreadcrumbsProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`BreadcrumbsProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`BreadcrumbsProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`BreadcrumbsProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`BreadcrumbsProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`BreadcrumbsProps.onInvalidCapture`

***

### onItemClick()[​](#onitemclick "Direct link to onItemClick()")

> **onItemClick**: (`item`) => `void`

Callback function when a breadcrumb item is clicked.

#### Parameters[​](#parameters "Direct link to Parameters")

##### item[​](#item "Direct link to item")

[`MuiBreadcrumbsItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBreadcrumbsItemProps)

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`BreadcrumbsProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`BreadcrumbsProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`BreadcrumbsProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`BreadcrumbsProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`BreadcrumbsProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`BreadcrumbsProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`BreadcrumbsProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`BreadcrumbsProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`BreadcrumbsProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`BreadcrumbsProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`BreadcrumbsProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`BreadcrumbsProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`BreadcrumbsProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`BreadcrumbsProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`BreadcrumbsProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`BreadcrumbsProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`BreadcrumbsProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`BreadcrumbsProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`BreadcrumbsProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`BreadcrumbsProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`BreadcrumbsProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`BreadcrumbsProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`BreadcrumbsProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`BreadcrumbsProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`BreadcrumbsProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`BreadcrumbsProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`BreadcrumbsProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`BreadcrumbsProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`BreadcrumbsProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`BreadcrumbsProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`BreadcrumbsProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`BreadcrumbsProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`BreadcrumbsProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`BreadcrumbsProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`BreadcrumbsProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`BreadcrumbsProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`BreadcrumbsProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`BreadcrumbsProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`BreadcrumbsProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`BreadcrumbsProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`BreadcrumbsProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`BreadcrumbsProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`BreadcrumbsProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`BreadcrumbsProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`BreadcrumbsProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`BreadcrumbsProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`BreadcrumbsProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`BreadcrumbsProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`BreadcrumbsProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`BreadcrumbsProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`BreadcrumbsProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`BreadcrumbsProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`BreadcrumbsProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`BreadcrumbsProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`BreadcrumbsProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`BreadcrumbsProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`BreadcrumbsProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`BreadcrumbsProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`BreadcrumbsProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`BreadcrumbsProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`BreadcrumbsProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`BreadcrumbsProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`BreadcrumbsProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`BreadcrumbsProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`BreadcrumbsProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`BreadcrumbsProps.radioGroup`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`BreadcrumbsProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`BreadcrumbsProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`BreadcrumbsProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`BreadcrumbsProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`BreadcrumbsProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`BreadcrumbsProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`BreadcrumbsProps.security`

***

### separator?[​](#separator "Direct link to separator?")

> `optional` **separator**: `ReactNode`

Custom separator node.

#### Default[​](#default-4 "Direct link to Default")

```
'/'
```

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`BreadcrumbsProps.separator`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`BreadcrumbsProps.slot`

***

### slotProps?[​](#slotprops "Direct link to slotProps?")

> `optional` **slotProps**: `object`

The props used for each slot inside the Breadcumb.

#### collapsedIcon?[​](#collapsedicon "Direct link to collapsedIcon?")

> `optional` **collapsedIcon**: `SlotComponentProps`<`OverridableComponent`<`SvgIconTypeMap`<{ }, `"svg"`>> & `object`, `BreadcrumbsCollapsedIconSlotPropsOverrides`, `BreadcrumbsOwnerState`>

Props applied to the CollapsedIcon slot.

##### Default[​](#default-5 "Direct link to Default")

```
{}
```

#### Default[​](#default-6 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`BreadcrumbsProps.slotProps`

***

### slots?[​](#slots "Direct link to slots?")

> `optional` **slots**: `object`

The components used for each slot inside the Breadcumb. Either a string to use a HTML element or a component.

#### CollapsedIcon?[​](#collapsedicon-1 "Direct link to CollapsedIcon?")

> `optional` **CollapsedIcon**: `ElementType`<`any`, keyof IntrinsicElements>

#### Default[​](#default-7 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`BreadcrumbsProps.slots`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`BreadcrumbsProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`BreadcrumbsProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`BreadcrumbsProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`BreadcrumbsProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`BreadcrumbsProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`BreadcrumbsProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`BreadcrumbsProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`BreadcrumbsProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`BreadcrumbsProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`BreadcrumbsProps.unselectable`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`BreadcrumbsProps.vocab`


---

# Interface: MuiCardProps

Props for the MuiCard component.

## Extends[​](#extends "Direct link to Extends")

* `CardProps`.`DisabledProps`.`ReadOnlyProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`CardProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`CardProps.accessKey`

***

### actions[​](#actions "Direct link to actions")

> **actions**: `ReactNode`

Actions content.

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`CardProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`CardProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`CardProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`CardProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`CardProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`CardProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`CardProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`CardProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`CardProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`CardProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`CardProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`CardProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`CardProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`CardProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`CardProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`CardProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`CardProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`CardProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`CardProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`CardProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`CardProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`CardProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`CardProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`CardProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`CardProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`CardProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`CardProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`CardProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`CardProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`CardProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`CardProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`CardProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`CardProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`CardProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`CardProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`CardProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`CardProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`CardProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`CardProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`CardProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`CardProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`CardProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`CardProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`CardProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`CardProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`CardProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`CardProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`CardProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`CardProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`CardProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`CardProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`CardProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`CardProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`CardProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`CardProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`CardProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`CardProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The content of the component.

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`CardProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`CardClasses`> & `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`CardProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`CardProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`CardProps.color`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`CardProps.component`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`CardProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`CardProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`CardProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`CardProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`CardProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`CardProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`CardProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`CardProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the component will be disabled.

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`DisabledProps.disabled`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`CardProps.draggable`

***

### elevation?[​](#elevation "Direct link to elevation?")

> `optional` **elevation**: `number`

Shadow depth, corresponds to `dp` in the spec. It accepts values between 0 and 24 inclusive.

#### Default[​](#default "Direct link to Default")

```
1
```

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`CardProps.elevation`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`CardProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`CardProps.exportparts`

***

### header[​](#header "Direct link to header")

> **header**: `ReactNode`

Header content to display.

***

### headerAction[​](#headeraction "Direct link to headerAction")

> **headerAction**: `ReactNode`

Header action content.

***

### headerAvatar[​](#headeravatar "Direct link to headerAvatar")

> **headerAvatar**: `ReactNode`

Header avatar content.

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`CardProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`CardProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`CardProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`CardProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`CardProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`CardProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`CardProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`CardProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`CardProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`CardProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`CardProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`CardProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`CardProps.lang`

***

### media[​](#media "Direct link to media")

> **media**: `ReactNode`

Media content.

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`CardProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`CardProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`CardProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`CardProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`CardProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`CardProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`CardProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`CardProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`CardProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`CardProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`CardProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`CardProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`CardProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`CardProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`CardProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`CardProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`CardProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`CardProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`CardProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`CardProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`CardProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`CardProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`CardProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`CardProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`CardProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`CardProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`CardProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`CardProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`CardProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`CardProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`CardProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`CardProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`CardProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`CardProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`CardProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`CardProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`CardProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`CardProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`CardProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`CardProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`CardProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`CardProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`CardProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`CardProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`CardProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`CardProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`CardProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`CardProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`CardProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`CardProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`CardProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`CardProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`CardProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`CardProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`CardProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`CardProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`CardProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`CardProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`CardProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`CardProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`CardProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`CardProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`CardProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`CardProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`CardProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`CardProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`CardProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`CardProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`CardProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`CardProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`CardProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`CardProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`CardProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`CardProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`CardProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`CardProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`CardProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`CardProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`CardProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`CardProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`CardProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`CardProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`CardProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`CardProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`CardProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`CardProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`CardProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`CardProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`CardProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`CardProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`CardProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`CardProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`CardProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`CardProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`CardProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`CardProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`CardProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`CardProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`CardProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`CardProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`CardProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`CardProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`CardProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`CardProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`CardProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`CardProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`CardProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`CardProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`CardProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`CardProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`CardProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`CardProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`CardProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`CardProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`CardProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`CardProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`CardProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`CardProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`CardProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`CardProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`CardProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`CardProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`CardProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`CardProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`CardProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`CardProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`CardProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`CardProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`CardProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`CardProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`CardProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`CardProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`CardProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`CardProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`CardProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`CardProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`CardProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`CardProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`CardProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`CardProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`CardProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`CardProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`CardProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`CardProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`CardProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`CardProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`CardProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`CardProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`CardProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`CardProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`CardProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`CardProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`CardProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`CardProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`CardProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`CardProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`CardProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`CardProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`CardProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`CardProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`CardProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`CardProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`CardProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`CardProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`CardProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`CardProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`CardProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`CardProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`CardProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`CardProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`CardProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`CardProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`CardProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`CardProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`CardProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`CardProps.radioGroup`

***

### raised?[​](#raised "Direct link to raised?")

> `optional` **raised**: `boolean`

If `true`, the card will use raised styling.

#### Default[​](#default-1 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`CardProps.raised`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the component will be read-only.

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ReadOnlyProps.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLDivElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`CardProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`CardProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`CardProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`CardProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`CardProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`CardProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`CardProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`CardProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`CardProps.spellCheck`

***

### square?[​](#square "Direct link to square?")

> `optional` **square**: `boolean`

If `true`, rounded corners are disabled.

#### Default[​](#default-2 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`CardProps.square`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`CardProps.style`

***

### subHeader[​](#subheader "Direct link to subHeader")

> **subHeader**: `ReactNode`

Subheader content.

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`CardProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`CardProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`CardProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`CardProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`CardProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`CardProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`CardProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`CardProps.unselectable`

***

### useActions?[​](#useactions "Direct link to useActions?")

> `optional` **useActions**: `boolean`

Whether to show actions section.

***

### useCardActionArea?[​](#usecardactionarea "Direct link to useCardActionArea?")

> `optional` **useCardActionArea**: `boolean`

Whether to use card action area wrapper.

***

### useHeader?[​](#useheader "Direct link to useHeader?")

> `optional` **useHeader**: `boolean`

Whether to show the card header.

***

### useHeaderAction?[​](#useheaderaction "Direct link to useHeaderAction?")

> `optional` **useHeaderAction**: `boolean`

Whether to show header action area.

***

### useHeaderAvatar?[​](#useheaderavatar "Direct link to useHeaderAvatar?")

> `optional` **useHeaderAvatar**: `boolean`

Whether to show header avatar.

***

### useMedia?[​](#usemedia "Direct link to useMedia?")

> `optional` **useMedia**: `boolean`

Whether to show media section.

***

### useSubheader?[​](#usesubheader "Direct link to useSubheader?")

> `optional` **useSubheader**: `boolean`

Whether to show subheader.

***

### variant?[​](#variant "Direct link to variant?")

> `optional` **variant**: `OverridableStringUnion`<`"outlined"` | `"elevation"`, `PaperPropsVariantOverrides`>

The variant to use.

#### Default[​](#default-3 "Direct link to Default")

```
'elevation'
```

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`CardProps.variant`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`CardProps.vocab`


---

# Interface: MuiCheckboxProps

Props for the MuiCheckbox component.

## Extends[​](#extends "Direct link to Extends")

* `Pick`<`CheckboxProps`, `"checked"` | `"color"` | `"disabled"` | `"size"`>

## Properties[​](#properties "Direct link to Properties")

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

If `true`, the component is checked.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Pick.checked`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `OverridableStringUnion`<`"error"` | `"default"` | `"success"` | `"primary"` | `"secondary"` | `"warning"` | `"info"`, `CheckboxPropsColorOverrides`>

The color of the component. It supports both default and custom theme colors, which can be added as shown in the [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).

#### Default[​](#default "Direct link to Default")

```
'primary'
```

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Pick.color`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If `true`, the component is disabled.

#### Default[​](#default-1 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Pick.disabled`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the radio checkbox.

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`checked?`) => `void`

Callback fired when the checkbox state changes.

#### Parameters[​](#parameters "Direct link to Parameters")

##### checked?[​](#checked-1 "Direct link to checked?")

`boolean`

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `OverridableStringUnion`<`"small"` | `"large"` | `"medium"`, `CheckboxPropsSizeOverrides`>

The size of the component. `small` is equivalent to the dense checkbox styling.

#### Default[​](#default-2 "Direct link to Default")

```
'medium'
```

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Pick.size`


---

# Interface: MuiContainerProps

The MuiContainer component properties.

## Extends[​](#extends "Direct link to Extends")

* `ContainerProps`.`DisabledProps`.`ReadOnlyProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ContainerProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ContainerProps.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ContainerProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ContainerProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ContainerProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ContainerProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ContainerProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ContainerProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ContainerProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ContainerProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ContainerProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ContainerProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ContainerProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ContainerProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ContainerProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ContainerProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ContainerProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ContainerProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ContainerProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ContainerProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ContainerProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ContainerProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ContainerProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ContainerProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ContainerProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ContainerProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ContainerProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ContainerProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ContainerProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ContainerProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ContainerProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ContainerProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ContainerProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ContainerProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ContainerProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ContainerProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ContainerProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ContainerProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ContainerProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ContainerProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ContainerProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ContainerProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`ContainerProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`ContainerProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`ContainerProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`ContainerProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`ContainerProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`ContainerProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`ContainerProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`ContainerProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`ContainerProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`ContainerProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`ContainerProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`ContainerProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`ContainerProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`ContainerProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`ContainerProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`ContainerProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`ContainerProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`ContainerProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`ContainerClasses`> & `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`ContainerProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`ContainerProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`ContainerProps.color`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`ContainerProps.component`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`ContainerProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`ContainerProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`ContainerProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`ContainerProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`ContainerProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`ContainerProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`ContainerProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`ContainerProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the component will be disabled.

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`DisabledProps.disabled`

***

### disableGutters?[​](#disablegutters "Direct link to disableGutters?")

> `optional` **disableGutters**: `boolean`

If `true`, the left and right padding is removed.

#### Default[​](#default "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`ContainerProps.disableGutters`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`ContainerProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`ContainerProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`ContainerProps.exportparts`

***

### fixed?[​](#fixed "Direct link to fixed?")

> `optional` **fixed**: `boolean`

Set the max-width to match the min-width of the current breakpoint. This is useful if you'd prefer to design for a fixed set of sizes instead of trying to accommodate a fully fluid viewport. It's fluid by default.

#### Default[​](#default-1 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`ContainerProps.fixed`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`ContainerProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`ContainerProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`ContainerProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`ContainerProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`ContainerProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`ContainerProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`ContainerProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`ContainerProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`ContainerProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`ContainerProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`ContainerProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`ContainerProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`ContainerProps.lang`

***

### maxWidth?[​](#maxwidth "Direct link to maxWidth?")

> `optional` **maxWidth**: `false` | `Breakpoint`

Determine the max-width of the container. The container width grows with the size of the screen. Set to `false` to disable `maxWidth`.

#### Default[​](#default-2 "Direct link to Default")

```
'lg'
```

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`ContainerProps.maxWidth`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`ContainerProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`ContainerProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`ContainerProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`ContainerProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`ContainerProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`ContainerProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`ContainerProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`ContainerProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`ContainerProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`ContainerProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`ContainerProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`ContainerProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`ContainerProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`ContainerProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`ContainerProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`ContainerProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`ContainerProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`ContainerProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`ContainerProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`ContainerProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`ContainerProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`ContainerProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`ContainerProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`ContainerProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`ContainerProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`ContainerProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`ContainerProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`ContainerProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`ContainerProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`ContainerProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`ContainerProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`ContainerProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`ContainerProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`ContainerProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`ContainerProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`ContainerProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`ContainerProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`ContainerProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`ContainerProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`ContainerProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`ContainerProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`ContainerProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`ContainerProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`ContainerProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`ContainerProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`ContainerProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`ContainerProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`ContainerProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`ContainerProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`ContainerProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`ContainerProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`ContainerProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`ContainerProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`ContainerProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`ContainerProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`ContainerProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`ContainerProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`ContainerProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`ContainerProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`ContainerProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`ContainerProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`ContainerProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`ContainerProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`ContainerProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`ContainerProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`ContainerProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`ContainerProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`ContainerProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`ContainerProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`ContainerProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`ContainerProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`ContainerProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`ContainerProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`ContainerProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`ContainerProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`ContainerProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`ContainerProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`ContainerProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`ContainerProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`ContainerProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`ContainerProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`ContainerProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`ContainerProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`ContainerProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`ContainerProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`ContainerProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`ContainerProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`ContainerProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`ContainerProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`ContainerProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`ContainerProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`ContainerProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`ContainerProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`ContainerProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`ContainerProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`ContainerProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`ContainerProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`ContainerProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`ContainerProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`ContainerProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`ContainerProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`ContainerProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`ContainerProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`ContainerProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`ContainerProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`ContainerProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`ContainerProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`ContainerProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`ContainerProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`ContainerProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`ContainerProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`ContainerProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`ContainerProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`ContainerProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`ContainerProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`ContainerProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`ContainerProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`ContainerProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`ContainerProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`ContainerProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`ContainerProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`ContainerProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`ContainerProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`ContainerProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`ContainerProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`ContainerProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`ContainerProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`ContainerProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`ContainerProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`ContainerProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`ContainerProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`ContainerProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`ContainerProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`ContainerProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`ContainerProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`ContainerProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`ContainerProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`ContainerProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`ContainerProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`ContainerProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`ContainerProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`ContainerProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`ContainerProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`ContainerProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`ContainerProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`ContainerProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`ContainerProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`ContainerProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`ContainerProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`ContainerProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`ContainerProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`ContainerProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`ContainerProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`ContainerProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`ContainerProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`ContainerProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`ContainerProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`ContainerProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`ContainerProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`ContainerProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`ContainerProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`ContainerProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`ContainerProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`ContainerProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`ContainerProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`ContainerProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`ContainerProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`ContainerProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`ContainerProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`ContainerProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`ContainerProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`ContainerProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`ContainerProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`ContainerProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`ContainerProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ContainerProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the component will be read-only.

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`ReadOnlyProps.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLDivElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`ContainerProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ContainerProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`ContainerProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`ContainerProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`ContainerProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`ContainerProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`ContainerProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`ContainerProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`ContainerProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`ContainerProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`ContainerProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`ContainerProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`ContainerProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`ContainerProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`ContainerProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`ContainerProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`ContainerProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`ContainerProps.unselectable`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`ContainerProps.vocab`


---

# Interface: MuiDialogProps

Props for the MuiDialog component.

## Extends[​](#extends "Direct link to Extends")

* `Omit`<`DialogProps`, `"aria-dropeffect"` | `"aria-grabbed"` | `"components"` | `"componentsProps"` | `"onKeyPress"` | `"onKeyPressCapture"` | `"Backdrop"` | `"BackdropComponent"` | `"BackdropProps"` | `"PaperProps"` | `"Root"` | `"TransitionComponent"` | `"TransitionProps"`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Omit.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Omit.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Omit.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Omit.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`Omit.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`Omit.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`Omit.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`Omit.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`Omit.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`Omit.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`Omit.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`Omit.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`Omit.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`Omit.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`Omit.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

The id(s) of the element(s) that describe the dialog.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`Omit.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-8 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`Omit.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-9 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`Omit.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-10 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`Omit.aria-disabled`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-11 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`Omit.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`Omit.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`Omit.aria-flowto`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`Omit.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-12 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`Omit.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-13 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`Omit.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`Omit.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-14 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`Omit.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

The id(s) of the element(s) that label the dialog.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`Omit.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`Omit.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`Omit.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `boolean` | `"true"` | `"false"`

Informs assistive technologies that the element is modal. It's added on the element with role="dialog".

#### Default[​](#default "Direct link to Default")

```
true
```

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`Omit.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`Omit.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`Omit.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`Omit.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-15 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`Omit.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`Omit.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-16 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`Omit.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-17 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`Omit.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-18 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`Omit.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-19 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`Omit.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`Omit.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`Omit.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-20 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`Omit.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-21 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`Omit.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-22 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`Omit.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`Omit.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-24 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`Omit.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-25 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`Omit.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`Omit.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`Omit.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`Omit.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-26 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`Omit.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`Omit.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`Omit.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`Omit.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`Omit.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`Omit.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Dialog children, usually the included sub-components.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`Omit.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`DialogClasses`>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`Omit.classes`

***

### closeAfterTransition?[​](#closeaftertransition "Direct link to closeAfterTransition?")

> `optional` **closeAfterTransition**: `boolean`

When set to true the Modal waits until a nested Transition is completed before closing.

#### Default[​](#default-1 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`Omit.closeAfterTransition`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`Omit.color`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`Omit.component`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `null` | `Element` | () => `null` | `Element`

An HTML element or function that returns one. The `container` will have the portal children appended to it.

You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible.

By default, it uses the body of the top-level document object, so it's simply `document.body` most of the time.

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`Omit.container`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`Omit.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`Omit.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`Omit.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`Omit.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`Omit.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`Omit.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`Omit.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`Omit.dir`

***

### disableAutoFocus?[​](#disableautofocus "Direct link to disableAutoFocus?")

> `optional` **disableAutoFocus**: `boolean`

If `true`, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the `disableAutoFocus` prop.

Generally this should never be set to `true` as it makes the modal less accessible to assistive technologies, like screen readers.

#### Default[​](#default-2 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`Omit.disableAutoFocus`

***

### disableEnforceFocus?[​](#disableenforcefocus "Direct link to disableEnforceFocus?")

> `optional` **disableEnforceFocus**: `boolean`

If `true`, the modal will not prevent focus from leaving the modal while open.

Generally this should never be set to `true` as it makes the modal less accessible to assistive technologies, like screen readers.

#### Default[​](#default-3 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`Omit.disableEnforceFocus`

***

### disableEscapeKeyDown?[​](#disableescapekeydown "Direct link to disableEscapeKeyDown?")

> `optional` **disableEscapeKeyDown**: `boolean`

If `true`, hitting escape will not fire the `onClose` callback.

#### Default[​](#default-4 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`Omit.disableEscapeKeyDown`

***

### disablePortal?[​](#disableportal "Direct link to disablePortal?")

> `optional` **disablePortal**: `boolean`

The `children` will be under the DOM hierarchy of the parent component.

#### Default[​](#default-5 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`Omit.disablePortal`

***

### disableRestoreFocus?[​](#disablerestorefocus "Direct link to disableRestoreFocus?")

> `optional` **disableRestoreFocus**: `boolean`

If `true`, the modal will not restore focus to previously focused element once modal is hidden or unmounted.

#### Default[​](#default-6 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`Omit.disableRestoreFocus`

***

### disableScrollLock?[​](#disablescrolllock "Direct link to disableScrollLock?")

> `optional` **disableScrollLock**: `boolean`

Disable the scroll lock behavior.

#### Default[​](#default-7 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`Omit.disableScrollLock`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`Omit.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`Omit.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-27 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`Omit.exportparts`

***

### fullScreen?[​](#fullscreen "Direct link to fullScreen?")

> `optional` **fullScreen**: `boolean`

If `true`, the dialog is full-screen.

#### Default[​](#default-8 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`Omit.fullScreen`

***

### fullWidth?[​](#fullwidth "Direct link to fullWidth?")

> `optional` **fullWidth**: `boolean`

If `true`, the dialog stretches to `maxWidth`.

Notice that the dialog width grow is limited by the default margin.

#### Default[​](#default-9 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`Omit.fullWidth`

***

### handleClose()?[​](#handleclose "Direct link to handleClose()?")

> `optional` **handleClose**: () => `void`

Custom close handler function.

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`Omit.hidden`

***

### hideBackdrop?[​](#hidebackdrop "Direct link to hideBackdrop?")

> `optional` **hideBackdrop**: `boolean`

If `true`, the backdrop is not rendered.

#### Default[​](#default-10 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`Omit.hideBackdrop`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`Omit.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-28 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`Omit.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`Omit.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-29 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`Omit.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-30 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`Omit.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`Omit.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`Omit.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`Omit.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`Omit.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`Omit.itemType`

***

### keepMounted?[​](#keepmounted "Direct link to keepMounted?")

> `optional` **keepMounted**: `boolean`

Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.

#### Default[​](#default-11 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`Omit.keepMounted`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`Omit.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`Omit.lang`

***

### maxWidth?[​](#maxwidth "Direct link to maxWidth?")

> `optional` **maxWidth**: `false` | `Breakpoint`

Determine the max-width of the dialog. The dialog width grows with the size of the screen. Set to `false` to disable `maxWidth`.

#### Default[​](#default-12 "Direct link to Default")

```
'sm'
```

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`Omit.maxWidth`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`Omit.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`Omit.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`Omit.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`Omit.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`Omit.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`Omit.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`Omit.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`Omit.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`Omit.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`Omit.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`Omit.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`Omit.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`Omit.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`Omit.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`Omit.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`Omit.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`Omit.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`Omit.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`Omit.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`Omit.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`Omit.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`Omit.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`Omit.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`Omit.onClickCapture`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: (`event`, `reason`) => `void`

Callback fired when the component requests to be closed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

The event source of the callback.

##### reason[​](#reason "Direct link to reason")

Can be: `"escapeKeyDown"`, `"backdropClick"`.

`"backdropClick"` | `"escapeKeyDown"`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`Omit.onClose`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`Omit.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`Omit.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`Omit.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`Omit.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`Omit.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`Omit.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`Omit.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`Omit.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`Omit.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`Omit.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`Omit.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`Omit.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`Omit.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`Omit.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`Omit.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`Omit.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`Omit.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`Omit.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`Omit.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`Omit.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`Omit.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`Omit.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`Omit.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`Omit.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`Omit.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`Omit.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`Omit.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`Omit.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`Omit.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`Omit.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`Omit.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`Omit.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`Omit.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`Omit.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`Omit.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`Omit.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`Omit.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`Omit.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`Omit.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`Omit.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`Omit.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`Omit.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`Omit.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`Omit.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`Omit.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`Omit.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`Omit.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`Omit.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`Omit.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`Omit.onKeyDownCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`Omit.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`Omit.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`Omit.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`Omit.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`Omit.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`Omit.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`Omit.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`Omit.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`Omit.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`Omit.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`Omit.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`Omit.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`Omit.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`Omit.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`Omit.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`Omit.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`Omit.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`Omit.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`Omit.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`Omit.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`Omit.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`Omit.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`Omit.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`Omit.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`Omit.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`Omit.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`Omit.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`Omit.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`Omit.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`Omit.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`Omit.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`Omit.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`Omit.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`Omit.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`Omit.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`Omit.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`Omit.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`Omit.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`Omit.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`Omit.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`Omit.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`Omit.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`Omit.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`Omit.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`Omit.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`Omit.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`Omit.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`Omit.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`Omit.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`Omit.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`Omit.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`Omit.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`Omit.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`Omit.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`Omit.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`Omit.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`Omit.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`Omit.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`Omit.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`Omit.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`Omit.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`Omit.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`Omit.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`Omit.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`Omit.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`Omit.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`Omit.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`Omit.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`Omit.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`Omit.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`Omit.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`Omit.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`Omit.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`Omit.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`Omit.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`Omit.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`Omit.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`Omit.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`Omit.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`Omit.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`Omit.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`Omit.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`Omit.onTransitionEndCapture`

***

### onTransitionEnter()?[​](#ontransitionenter "Direct link to onTransitionEnter()?")

> `optional` **onTransitionEnter**: () => `void`

A function called when a transition enters.

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`Omit.onTransitionEnter`

***

### onTransitionExited()?[​](#ontransitionexited "Direct link to onTransitionExited()?")

> `optional` **onTransitionExited**: () => `void`

A function called when a transition has exited.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`Omit.onTransitionExited`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`Omit.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`Omit.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`Omit.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`Omit.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`Omit.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`Omit.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`Omit.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`Omit.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`Omit.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`Omit.onWheelCapture`

***

### open[​](#open "Direct link to open")

> **open**: `boolean`

If `true`, the component is shown.

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`Omit.open`

***

### PaperComponent?[​](#papercomponent "Direct link to PaperComponent?")

> `optional` **PaperComponent**: `JSXElementConstructor`<`PaperProps`>

The component used to render the body of the dialog.

#### Default[​](#default-13 "Direct link to Default")

```
Paper
```

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`Omit.PaperComponent`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-31 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`Omit.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`Omit.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`Omit.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`Omit.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`Omit.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`Omit.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`Omit.radioGroup`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `null` | (`instance`) => `void` | () => `VoidOrUndefinedOnly` | `RefObject`<`null` | `HTMLDivElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-32 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`Omit.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`Omit.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`Omit.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`Omit.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`Omit.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`Omit.role`

***

### scroll?[​](#scroll "Direct link to scroll?")

> `optional` **scroll**: `"body"` | `"paper"`

Determine the container for scrolling the dialog.

#### Default[​](#default-14 "Direct link to Default")

```
'paper'
```

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`Omit.scroll`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`Omit.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`Omit.slot`

***

### slotProps?[​](#slotprops "Direct link to slotProps?")

> `optional` **slotProps**: `object`

The props used for each slot inside.

#### backdrop?[​](#backdrop "Direct link to backdrop?")

> `optional` **backdrop**: `SlotProps`<`ElementType`<`BackdropProps`, keyof IntrinsicElements>, `DialogBackdropSlotPropsOverrides`, `DialogOwnerState`>

Props forwarded to the backdrop slot. By default, the available props are based on the [Backdrop](https://mui.com/material-ui/api/backdrop/#props) component.

#### container?[​](#container-1 "Direct link to container?")

> `optional` **container**: `SlotProps`<`"div"`, `DialogContainerSlotPropsOverrides`, `DialogOwnerState`>

Props forwarded to the container slot. By default, the available props are based on a div element.

#### paper?[​](#paper "Direct link to paper?")

> `optional` **paper**: `SlotProps`<`ElementType`<`PaperProps`, keyof IntrinsicElements>, `DialogPaperSlotPropsOverrides`, `DialogOwnerState`>

Props forwarded to the paper slot. By default, the available props are based on the [Paper](https://mui.com/material-ui/api/paper/#props) component.

#### root?[​](#root "Direct link to root?")

> `optional` **root**: `SlotProps`<`ElementType`<`ModalProps`, keyof IntrinsicElements>, `DialogRootSlotPropsOverrides`, `DialogOwnerState`>

Props forwarded to the root slot. By default, the available props are based on the [Modal](https://mui.com/material-ui/api/modal/#props) component.

#### transition?[​](#transition "Direct link to transition?")

> `optional` **transition**: `SlotComponentProps`<`ElementType`<`any`, keyof IntrinsicElements>, `TransitionProps` & `DialogTransitionSlotPropsOverrides`, `DialogOwnerState`>

Props forwarded to the transition slot. By default, the available props are based on the [Fade](https://mui.com/material-ui/api/fade/#props) component.

#### Default[​](#default-15 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`Omit.slotProps`

***

### slots?[​](#slots "Direct link to slots?")

> `optional` **slots**: `Partial`<`DialogSlots`>

The components used for each slot inside.

#### Default[​](#default-16 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`Omit.slots`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`Omit.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`Omit.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`Omit.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`Omit.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`Omit.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`Omit.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`Omit.title`

***

### transitionDuration?[​](#transitionduration "Direct link to transitionDuration?")

> `optional` **transitionDuration**: `number` | { `appear?`: `number`; `enter?`: `number`; `exit?`: `number`; } | { `appear?`: `number`; `enter?`: `number`; `exit?`: `number`; }

The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.

#### Default[​](#default-17 "Direct link to Default")

```
{
   *   enter: theme.transitions.duration.enteringScreen,
   *   exit: theme.transitions.duration.leavingScreen,
   * }
```

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`Omit.transitionDuration`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`Omit.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`Omit.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`Omit.unselectable`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`Omit.vocab`


---

# Interface: MuiFormControlLabelProps

Props for the MuiFormControlLabel component.

## Extends[​](#extends "Direct link to Extends")

* `Omit`<`FormControlLabelProps`, `"control"` | `"onChange"`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Omit.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Omit.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Omit.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Omit.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`Omit.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`Omit.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`Omit.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`Omit.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`Omit.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`Omit.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`Omit.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`Omit.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`Omit.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`Omit.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`Omit.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`Omit.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`Omit.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`Omit.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`Omit.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`Omit.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`Omit.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`Omit.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`Omit.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`Omit.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`Omit.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`Omit.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`Omit.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`Omit.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`Omit.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`Omit.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`Omit.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`Omit.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`Omit.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`Omit.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`Omit.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`Omit.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`Omit.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`Omit.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`Omit.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`Omit.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`Omit.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`Omit.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`Omit.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`Omit.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`Omit.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`Omit.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`Omit.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`Omit.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`Omit.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`Omit.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`Omit.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`Omit.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`Omit.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`Omit.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`Omit.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`Omit.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`Omit.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`Omit.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`Omit.autoSave`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

If `true`, the component appears selected.

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`Omit.checked`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`FormControlLabelClasses`>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`Omit.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`Omit.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`Omit.color`

***

### ~~componentsProps?~~[​](#componentsprops "Direct link to componentsprops")

> `optional` **componentsProps**: `object`

The props used for each slot inside.

#### ~~typography?~~[​](#typography "Direct link to typography")

> `optional` **typography**: `TypographyProps`

Props applied to the Typography wrapper of the passed label. This is unused if disableTypography is true.

##### Default[​](#default "Direct link to Default")

```
{}
```

#### Default[​](#default-1 "Direct link to Default")

```
{}
```

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

use the `slotProps` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`Omit.componentsProps`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`Omit.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`Omit.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`Omit.contextMenu`

***

### control[​](#control "Direct link to control")

> **control**: `string`

Type of control to use (Checkbox, Radio, or Switch).

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`Omit.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`Omit.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`Omit.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`Omit.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`Omit.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If `true`, the control is disabled.

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`Omit.disabled`

***

### disableTypography?[​](#disabletypography "Direct link to disableTypography?")

> `optional` **disableTypography**: `boolean`

If `true`, the label is rendered as it is passed without an additional typography node.

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`Omit.disableTypography`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`Omit.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`Omit.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`Omit.exportparts`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`Omit.form`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`Omit.hidden`

***

### htmlFor?[​](#htmlfor "Direct link to htmlFor?")

> `optional` **htmlFor**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`Omit.htmlFor`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`Omit.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`Omit.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`Omit.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`Omit.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Pass a ref to the `input` element.

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`Omit.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`Omit.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`Omit.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`Omit.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`Omit.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`Omit.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`Omit.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `ReactNode`

A text or an element to be used in an enclosing label element.

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`Omit.label`

***

### labelPlacement?[​](#labelplacement "Direct link to labelPlacement?")

> `optional` **labelPlacement**: `"bottom"` | `"top"` | `"start"` | `"end"`

The position of the label.

#### Default[​](#default-2 "Direct link to Default")

```
'end'
```

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`Omit.labelPlacement`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`Omit.lang`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`Omit.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`Omit.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`Omit.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`Omit.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`Omit.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`Omit.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`Omit.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`Omit.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`Omit.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`Omit.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`Omit.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`Omit.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`Omit.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`Omit.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`Omit.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`Omit.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`Omit.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`Omit.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`Omit.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`Omit.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`Omit.onCanPlayThroughCapture`

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`checked?`) => `void`

Callback fired when the control state changes.

#### Parameters[​](#parameters "Direct link to Parameters")

##### checked?[​](#checked-1 "Direct link to checked?")

`boolean`

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`Omit.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`Omit.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`Omit.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`Omit.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`Omit.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`Omit.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`Omit.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`Omit.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`Omit.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`Omit.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`Omit.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`Omit.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`Omit.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`Omit.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`Omit.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`Omit.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`Omit.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`Omit.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`Omit.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`Omit.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`Omit.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`Omit.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`Omit.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`Omit.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`Omit.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`Omit.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`Omit.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`Omit.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`Omit.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`Omit.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`Omit.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`Omit.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`Omit.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`Omit.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`Omit.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`Omit.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`Omit.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`Omit.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`Omit.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`Omit.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`Omit.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`Omit.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`Omit.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`Omit.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`Omit.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`Omit.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`Omit.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`Omit.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`Omit.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`Omit.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`Omit.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`Omit.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`Omit.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLLabelElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`Omit.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLLabelElement`>

#### Deprecated[​](#deprecated-4 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`Omit.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`Omit.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`Omit.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`Omit.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`Omit.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`Omit.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`Omit.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`Omit.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`Omit.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`Omit.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`Omit.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`Omit.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`Omit.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`Omit.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`Omit.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`Omit.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`Omit.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`Omit.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`Omit.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`Omit.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`Omit.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`Omit.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`Omit.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`Omit.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`Omit.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`Omit.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`Omit.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`Omit.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`Omit.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`Omit.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`Omit.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`Omit.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`Omit.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`Omit.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`Omit.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`Omit.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`Omit.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`Omit.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`Omit.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`Omit.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`Omit.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`Omit.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`Omit.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`Omit.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`Omit.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`Omit.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`Omit.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`Omit.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`Omit.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`Omit.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`Omit.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`Omit.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`Omit.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`Omit.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`Omit.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`Omit.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`Omit.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`Omit.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`Omit.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`Omit.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`Omit.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`Omit.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`Omit.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`Omit.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`Omit.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`Omit.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`Omit.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`Omit.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`Omit.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`Omit.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`Omit.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`Omit.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`Omit.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`Omit.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`Omit.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`Omit.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`Omit.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`Omit.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`Omit.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`Omit.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`Omit.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`Omit.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`Omit.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`Omit.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`Omit.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`Omit.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`Omit.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`Omit.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`Omit.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`Omit.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`Omit.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`Omit.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`Omit.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLLabelElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`Omit.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`Omit.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`Omit.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`Omit.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`Omit.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`Omit.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`Omit.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`Omit.radioGroup`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`unknown`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`Omit.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`Omit.rel`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

If `true`, the label will indicate that the `input` is required.

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`Omit.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`Omit.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`Omit.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`Omit.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`Omit.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`Omit.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`Omit.slot`

***

### slotProps?[​](#slotprops "Direct link to slotProps?")

> `optional` **slotProps**: `object`

The props used for each slot inside.

#### typography?[​](#typography-1 "Direct link to typography?")

> `optional` **typography**: `SlotProps`<`OverridableComponent`<`TypographyTypeMap`<{ }, `"span"`>>, { }, `FormControlLabelProps`>

#### Default[​](#default-3 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`Omit.slotProps`

***

### slots?[​](#slots "Direct link to slots?")

> `optional` **slots**: `Partial`<`FormControlLabelSlots`>

The components used for each slot inside.

#### Default[​](#default-4 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`Omit.slots`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`Omit.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`Omit.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`Omit.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`Omit.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`Omit.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`Omit.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`Omit.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`Omit.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`Omit.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`Omit.unselectable`

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `unknown`

The value of the component.

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`Omit.value`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`Omit.vocab`


---

# Interface: MuiFormControlProps

Props for the Material-UI FormControl component.

## Extends[​](#extends "Direct link to Extends")

* `FormControlProps`.`DisabledProps`.`ReadOnlyProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`FormControlProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`FormControlProps.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`FormControlProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`FormControlProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`FormControlProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`FormControlProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`FormControlProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`FormControlProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`FormControlProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`FormControlProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`FormControlProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`FormControlProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`FormControlProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`FormControlProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`FormControlProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`FormControlProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`FormControlProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`FormControlProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`FormControlProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`FormControlProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`FormControlProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`FormControlProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`FormControlProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`FormControlProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`FormControlProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`FormControlProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`FormControlProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`FormControlProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`FormControlProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`FormControlProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`FormControlProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`FormControlProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`FormControlProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`FormControlProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`FormControlProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`FormControlProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`FormControlProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`FormControlProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`FormControlProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`FormControlProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`FormControlProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`FormControlProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`FormControlProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`FormControlProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`FormControlProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`FormControlProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`FormControlProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`FormControlProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`FormControlProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`FormControlProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`FormControlProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`FormControlProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`FormControlProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`FormControlProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`FormControlProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`FormControlProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`FormControlProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`FormControlProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`FormControlProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The content of the component.

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`FormControlProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`FormControlClasses`> & `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`FormControlProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`FormControlProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `OverridableStringUnion`<`"error"` | `"success"` | `"primary"` | `"secondary"` | `"warning"` | `"info"`, `FormControlPropsColorOverrides`>

The color of the component. It supports both default and custom theme colors, which can be added as shown in the [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).

#### Default[​](#default "Direct link to Default")

```
'primary'
```

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`FormControlProps.color`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`FormControlProps.component`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`FormControlProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`FormControlProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`FormControlProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`FormControlProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`FormControlProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`FormControlProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`FormControlProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`FormControlProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If `true`, the label, input and helper text should be displayed in a disabled state.

#### Default[​](#default-1 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`FormControlProps.disabled`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`FormControlProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`FormControlProps.enterKeyHint`

***

### error?[​](#error "Direct link to error?")

> `optional` **error**: `boolean`

If `true`, the label is displayed in an error state.

#### Default[​](#default-2 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`FormControlProps.error`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`FormControlProps.exportparts`

***

### focused?[​](#focused "Direct link to focused?")

> `optional` **focused**: `boolean`

If `true`, the component is displayed in focused state.

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`FormControlProps.focused`

***

### fullWidth?[​](#fullwidth "Direct link to fullWidth?")

> `optional` **fullWidth**: `boolean`

If `true`, the component will take up the full width of its container.

#### Default[​](#default-3 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`FormControlProps.fullWidth`

***

### helperText?[​](#helpertext "Direct link to helperText?")

> `optional` **helperText**: `string`

The error message for the form control.

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`FormControlProps.hidden`

***

### hiddenLabel?[​](#hiddenlabel "Direct link to hiddenLabel?")

> `optional` **hiddenLabel**: `boolean`

If `true`, the label is hidden. This is used to increase density for a `FilledInput`. Be sure to add `aria-label` to the `input` element.

#### Default[​](#default-4 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`FormControlProps.hiddenLabel`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`FormControlProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`FormControlProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`FormControlProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`FormControlProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`FormControlProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`FormControlProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`FormControlProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`FormControlProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`FormControlProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`FormControlProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`FormControlProps.key`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the form control.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`FormControlProps.lang`

***

### margin?[​](#margin "Direct link to margin?")

> `optional` **margin**: `"none"` | `"normal"` | `"dense"`

If `dense` or `normal`, will adjust vertical spacing of this and contained components.

#### Default[​](#default-5 "Direct link to Default")

```
'none'
```

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`FormControlProps.margin`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`FormControlProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`FormControlProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`FormControlProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`FormControlProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`FormControlProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`FormControlProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`FormControlProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`FormControlProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`FormControlProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`FormControlProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`FormControlProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`FormControlProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`FormControlProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`FormControlProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`FormControlProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`FormControlProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`FormControlProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`FormControlProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`FormControlProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`FormControlProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`FormControlProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`FormControlProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`FormControlProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`FormControlProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`FormControlProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`FormControlProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`FormControlProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`FormControlProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`FormControlProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`FormControlProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`FormControlProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`FormControlProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`FormControlProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`FormControlProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`FormControlProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`FormControlProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`FormControlProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`FormControlProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`FormControlProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`FormControlProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`FormControlProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`FormControlProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`FormControlProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`FormControlProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`FormControlProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`FormControlProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`FormControlProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`FormControlProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`FormControlProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`FormControlProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`FormControlProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`FormControlProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`FormControlProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`FormControlProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`FormControlProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`FormControlProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`FormControlProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`FormControlProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`FormControlProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`FormControlProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`FormControlProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`FormControlProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`FormControlProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`FormControlProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`FormControlProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`FormControlProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`FormControlProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`FormControlProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`FormControlProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`FormControlProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`FormControlProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`FormControlProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`FormControlProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`FormControlProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`FormControlProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`FormControlProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`FormControlProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`FormControlProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`FormControlProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`FormControlProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`FormControlProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`FormControlProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`FormControlProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`FormControlProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`FormControlProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`FormControlProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`FormControlProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`FormControlProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`FormControlProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`FormControlProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`FormControlProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`FormControlProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`FormControlProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`FormControlProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`FormControlProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`FormControlProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`FormControlProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`FormControlProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`FormControlProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`FormControlProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`FormControlProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`FormControlProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`FormControlProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`FormControlProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`FormControlProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`FormControlProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`FormControlProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`FormControlProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`FormControlProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`FormControlProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`FormControlProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`FormControlProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`FormControlProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`FormControlProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`FormControlProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`FormControlProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`FormControlProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`FormControlProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`FormControlProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`FormControlProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`FormControlProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`FormControlProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`FormControlProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`FormControlProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`FormControlProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`FormControlProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`FormControlProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`FormControlProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`FormControlProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`FormControlProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`FormControlProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`FormControlProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`FormControlProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`FormControlProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`FormControlProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`FormControlProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`FormControlProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`FormControlProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`FormControlProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`FormControlProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`FormControlProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`FormControlProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`FormControlProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`FormControlProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`FormControlProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`FormControlProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`FormControlProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`FormControlProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`FormControlProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`FormControlProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`FormControlProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`FormControlProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`FormControlProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`FormControlProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`FormControlProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`FormControlProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`FormControlProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`FormControlProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`FormControlProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`FormControlProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`FormControlProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`FormControlProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`FormControlProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`FormControlProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`FormControlProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`FormControlProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`FormControlProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`FormControlProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`FormControlProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`FormControlProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`FormControlProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`FormControlProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`FormControlProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`FormControlProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`FormControlProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`FormControlProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the component will be read-only.

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ReadOnlyProps.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLDivElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`FormControlProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`FormControlProps.rel`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

If true, the form control will be required.

#### Overrides[​](#overrides "Direct link to Overrides")

`FormControlProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`FormControlProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`FormControlProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`FormControlProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`FormControlProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`FormControlProps.security`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `OverridableStringUnion`<`"small"` | `"medium"`, `FormControlPropsSizeOverrides`>

The size of the component.

#### Default[​](#default-6 "Direct link to Default")

```
'medium'
```

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`FormControlProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`FormControlProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`FormControlProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`FormControlProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`FormControlProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`FormControlProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`FormControlProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`FormControlProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`FormControlProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`FormControlProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`FormControlProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`FormControlProps.unselectable`

***

### variant?[​](#variant "Direct link to variant?")

> `optional` **variant**: `"filled"` | `"outlined"` | `"standard"`

The variant to use.

#### Default[​](#default-7 "Direct link to Default")

```
'outlined'
```

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`FormControlProps.variant`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`FormControlProps.vocab`


---

# Interface: MuiListItemProps

The MuiListItem component properties.

## Extends[​](#extends "Direct link to Extends")

* `ListItemProps`.`DisabledProps`.`ReadOnlyProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ListItemProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ListItemProps.accessKey`

***

### alignItems?[​](#alignitems "Direct link to alignItems?")

> `optional` **alignItems**: `"center"` | `"flex-start"`

Defines the `align-items` style property.

#### Default[​](#default "Direct link to Default")

```
'center'
```

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ListItemProps.alignItems`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ListItemProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ListItemProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ListItemProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ListItemProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ListItemProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ListItemProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ListItemProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ListItemProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ListItemProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ListItemProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ListItemProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ListItemProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ListItemProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ListItemProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ListItemProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ListItemProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ListItemProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ListItemProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ListItemProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ListItemProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ListItemProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ListItemProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ListItemProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ListItemProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ListItemProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ListItemProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ListItemProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ListItemProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ListItemProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ListItemProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ListItemProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ListItemProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ListItemProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ListItemProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ListItemProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ListItemProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ListItemProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ListItemProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ListItemProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`ListItemProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`ListItemProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`ListItemProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`ListItemProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`ListItemProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`ListItemProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`ListItemProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`ListItemProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`ListItemProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`ListItemProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`ListItemProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`ListItemProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`ListItemProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`ListItemProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`ListItemProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`ListItemProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`ListItemProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`ListItemProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The content of the component if a `ListItemSecondaryAction` is used it must be the last child.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`ListItemProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`ListItemClasses`> & `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`ListItemProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`ListItemProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`ListItemProps.color`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`ListItemProps.component`

***

### ~~components?~~[​](#components "Direct link to components")

> `optional` **components**: `object`

The components used for each slot inside.

#### ~~Root?~~[​](#root "Direct link to root")

> `optional` **Root**: `ElementType`<`any`, keyof IntrinsicElements>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use the `slots` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.

#### Default[​](#default-1 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`ListItemProps.components`

***

### ~~componentsProps?~~[​](#componentsprops "Direct link to componentsprops")

> `optional` **componentsProps**: `object`

The extra props for the slot components. You can override the existing props or add new ones.

#### ~~root?~~[​](#root-1 "Direct link to root-1")

> `optional` **root**: `HTMLAttributes`<`HTMLDivElement`> & `ListItemComponentsPropsOverrides`

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use the `slotProps` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.

#### Default[​](#default-2 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`ListItemProps.componentsProps`

***

### ~~ContainerComponent?~~[​](#containercomponent "Direct link to containercomponent")

> `optional` **ContainerComponent**: `ElementType`<`HTMLAttributes`<`HTMLDivElement`>, keyof IntrinsicElements>

The container component used when a `ListItemSecondaryAction` is the last child.

#### Default[​](#default-3 "Direct link to Default")

```
'li'
```

#### Deprecated[​](#deprecated-4 "Direct link to Deprecated")

Use the `component` or `slots.root` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`ListItemProps.ContainerComponent`

***

### ~~ContainerProps?~~[​](#containerprops "Direct link to containerprops")

> `optional` **ContainerProps**: `HTMLAttributes`<`HTMLDivElement`>

Props applied to the container component if used.

#### Default[​](#default-4 "Direct link to Default")

```
{}
```

#### Deprecated[​](#deprecated-5 "Direct link to Deprecated")

Use the `slotProps.root` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`ListItemProps.ContainerProps`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`ListItemProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`ListItemProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`ListItemProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`ListItemProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`ListItemProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`ListItemProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`ListItemProps.defaultValue`

***

### dense?[​](#dense "Direct link to dense?")

> `optional` **dense**: `boolean`

If `true`, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.

#### Default[​](#default-5 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`ListItemProps.dense`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`ListItemProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the component will be disabled.

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`DisabledProps.disabled`

***

### disableGutters?[​](#disablegutters "Direct link to disableGutters?")

> `optional` **disableGutters**: `boolean`

If `true`, the left and right padding is removed.

#### Default[​](#default-6 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`ListItemProps.disableGutters`

***

### disablePadding?[​](#disablepadding "Direct link to disablePadding?")

> `optional` **disablePadding**: `boolean`

If `true`, all padding is removed.

#### Default[​](#default-7 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`ListItemProps.disablePadding`

***

### divider?[​](#divider "Direct link to divider?")

> `optional` **divider**: `boolean`

If `true`, a 1px light border is added to the bottom of the list item.

#### Default[​](#default-8 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`ListItemProps.divider`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`ListItemProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`ListItemProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`ListItemProps.exportparts`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`ListItemProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`ListItemProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`ListItemProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`ListItemProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`ListItemProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`ListItemProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`ListItemProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`ListItemProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`ListItemProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`ListItemProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`ListItemProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`ListItemProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`ListItemProps.lang`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`ListItemProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`ListItemProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`ListItemProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`ListItemProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`ListItemProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`ListItemProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`ListItemProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`ListItemProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`ListItemProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`ListItemProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`ListItemProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`ListItemProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`ListItemProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`ListItemProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`ListItemProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`ListItemProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`ListItemProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`ListItemProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`ListItemProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`ListItemProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`ListItemProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`ListItemProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`ListItemProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`ListItemProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`ListItemProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`ListItemProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`ListItemProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`ListItemProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`ListItemProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`ListItemProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`ListItemProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`ListItemProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`ListItemProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`ListItemProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`ListItemProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`ListItemProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`ListItemProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`ListItemProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`ListItemProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`ListItemProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`ListItemProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`ListItemProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`ListItemProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`ListItemProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`ListItemProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`ListItemProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`ListItemProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`ListItemProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`ListItemProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`ListItemProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`ListItemProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`ListItemProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`ListItemProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`ListItemProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`ListItemProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`ListItemProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`ListItemProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`ListItemProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`ListItemProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`ListItemProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`ListItemProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`ListItemProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`ListItemProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`ListItemProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`ListItemProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`ListItemProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`ListItemProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`ListItemProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`ListItemProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`ListItemProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`ListItemProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`ListItemProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`ListItemProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`ListItemProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLLIElement`>

#### Deprecated[​](#deprecated-6 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`ListItemProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLLIElement`>

#### Deprecated[​](#deprecated-7 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`ListItemProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`ListItemProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`ListItemProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`ListItemProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`ListItemProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`ListItemProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`ListItemProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`ListItemProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`ListItemProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`ListItemProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`ListItemProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`ListItemProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`ListItemProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`ListItemProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`ListItemProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`ListItemProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`ListItemProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`ListItemProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`ListItemProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`ListItemProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`ListItemProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`ListItemProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`ListItemProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`ListItemProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`ListItemProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`ListItemProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`ListItemProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`ListItemProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`ListItemProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`ListItemProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`ListItemProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`ListItemProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`ListItemProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`ListItemProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`ListItemProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`ListItemProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`ListItemProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`ListItemProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`ListItemProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`ListItemProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`ListItemProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`ListItemProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`ListItemProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`ListItemProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`ListItemProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`ListItemProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`ListItemProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`ListItemProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`ListItemProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`ListItemProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`ListItemProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`ListItemProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`ListItemProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`ListItemProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`ListItemProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`ListItemProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`ListItemProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`ListItemProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`ListItemProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`ListItemProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`ListItemProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`ListItemProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`ListItemProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`ListItemProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`ListItemProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`ListItemProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`ListItemProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`ListItemProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`ListItemProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`ListItemProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`ListItemProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`ListItemProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`ListItemProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`ListItemProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`ListItemProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`ListItemProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`ListItemProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`ListItemProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`ListItemProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`ListItemProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`ListItemProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`ListItemProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`ListItemProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`ListItemProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`ListItemProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`ListItemProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`ListItemProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`ListItemProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`ListItemProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`ListItemProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`ListItemProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`ListItemProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`ListItemProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLLIElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`ListItemProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ListItemProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`ListItemProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`ListItemProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ListItemProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`ListItemProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`ListItemProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`ListItemProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the component will be read-only.

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`ReadOnlyProps.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLLIElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`ListItemProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`ListItemProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`ListItemProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`ListItemProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`ListItemProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`ListItemProps.role`

***

### secondaryAction?[​](#secondaryaction "Direct link to secondaryAction?")

> `optional` **secondaryAction**: `ReactNode`

The element to display at the end of ListItem.

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`ListItemProps.secondaryAction`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`ListItemProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`ListItemProps.slot`

***

### slotProps?[​](#slotprops "Direct link to slotProps?")

> `optional` **slotProps**: `object`

The extra props for the slot components. You can override the existing props or add new ones.

#### root?[​](#root-2 "Direct link to root?")

> `optional` **root**: `HTMLAttributes`<`HTMLDivElement`> & `ListItemComponentsPropsOverrides`

#### secondaryAction?[​](#secondaryaction-1 "Direct link to secondaryAction?")

> `optional` **secondaryAction**: `SlotProps`<`ElementType`<`HTMLAttributes`<`HTMLDivElement`>, keyof IntrinsicElements>, `ListItemSecondaryActionSlotPropsOverrides`, `ListItemOwnerState`>

#### Default[​](#default-9 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`ListItemProps.slotProps`

***

### slots?[​](#slots "Direct link to slots?")

> `optional` **slots**: `object`

The components used for each slot inside.

#### root?[​](#root-3 "Direct link to root?")

> `optional` **root**: `ElementType`<`any`, keyof IntrinsicElements>

#### secondaryAction?[​](#secondaryaction-2 "Direct link to secondaryAction?")

> `optional` **secondaryAction**: `ElementType`<`any`, keyof IntrinsicElements>

#### Default[​](#default-10 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`ListItemProps.slots`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`ListItemProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`ListItemProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`ListItemProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`ListItemProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`ListItemProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`ListItemProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`ListItemProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`ListItemProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`ListItemProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`ListItemProps.unselectable`

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`ListItemProps.value`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`ListItemProps.vocab`


---

# Interface: MuiListProps

The MuiList component properties.

## Extends[​](#extends "Direct link to Extends")

* `ListProps`.`DisabledProps`.`ReadOnlyProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ListProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ListProps.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ListProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ListProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ListProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ListProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ListProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ListProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ListProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ListProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ListProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ListProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ListProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ListProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ListProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ListProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ListProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ListProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ListProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ListProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ListProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ListProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ListProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ListProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ListProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ListProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ListProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ListProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ListProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ListProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ListProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ListProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ListProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ListProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ListProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ListProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ListProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ListProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ListProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ListProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ListProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ListProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`ListProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`ListProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`ListProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`ListProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`ListProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`ListProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`ListProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`ListProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`ListProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`ListProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`ListProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`ListProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`ListProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`ListProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`ListProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`ListProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`ListProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The content of the component.

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`ListProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`ListClasses`> & `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`ListProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`ListProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`ListProps.color`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`ListProps.component`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`ListProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`ListProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`ListProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`ListProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`ListProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`ListProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`ListProps.defaultValue`

***

### dense?[​](#dense "Direct link to dense?")

> `optional` **dense**: `boolean`

If `true`, compact vertical padding designed for keyboard and mouse input is used for the list and list items. The prop is available to descendant components as the `dense` context.

#### Default[​](#default "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`ListProps.dense`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`ListProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the component will be disabled.

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`DisabledProps.disabled`

***

### disablePadding?[​](#disablepadding "Direct link to disablePadding?")

> `optional` **disablePadding**: `boolean`

If `true`, vertical padding is removed from the list.

#### Default[​](#default-1 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`ListProps.disablePadding`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`ListProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`ListProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`ListProps.exportparts`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`ListProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`ListProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`ListProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`ListProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`ListProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`ListProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`ListProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`ListProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`ListProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`ListProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`ListProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`ListProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`ListProps.lang`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`ListProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`ListProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`ListProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`ListProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`ListProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`ListProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`ListProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`ListProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`ListProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`ListProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`ListProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`ListProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`ListProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`ListProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`ListProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`ListProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`ListProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`ListProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`ListProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`ListProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`ListProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`ListProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`ListProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`ListProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`ListProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`ListProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`ListProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`ListProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`ListProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`ListProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`ListProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`ListProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`ListProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`ListProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`ListProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`ListProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`ListProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`ListProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`ListProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`ListProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`ListProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`ListProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`ListProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`ListProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`ListProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`ListProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`ListProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`ListProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`ListProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`ListProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`ListProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`ListProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`ListProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`ListProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`ListProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`ListProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`ListProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`ListProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`ListProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`ListProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`ListProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`ListProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`ListProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`ListProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`ListProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`ListProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`ListProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`ListProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`ListProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`ListProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`ListProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`ListProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`ListProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`ListProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLUListElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`ListProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLUListElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`ListProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`ListProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`ListProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`ListProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`ListProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`ListProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`ListProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`ListProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`ListProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`ListProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`ListProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`ListProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`ListProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`ListProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`ListProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`ListProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`ListProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`ListProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`ListProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`ListProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`ListProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`ListProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`ListProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`ListProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`ListProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`ListProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`ListProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`ListProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`ListProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`ListProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`ListProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`ListProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`ListProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`ListProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`ListProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`ListProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`ListProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`ListProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`ListProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`ListProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`ListProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`ListProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`ListProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`ListProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`ListProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`ListProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`ListProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`ListProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`ListProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`ListProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`ListProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`ListProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`ListProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`ListProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`ListProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`ListProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`ListProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`ListProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`ListProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`ListProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`ListProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`ListProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`ListProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`ListProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`ListProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`ListProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`ListProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`ListProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`ListProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`ListProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`ListProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`ListProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`ListProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`ListProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`ListProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`ListProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`ListProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`ListProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`ListProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`ListProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`ListProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`ListProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`ListProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`ListProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`ListProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`ListProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`ListProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`ListProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`ListProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`ListProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`ListProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`ListProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`ListProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLUListElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`ListProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`ListProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`ListProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`ListProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`ListProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`ListProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`ListProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`ListProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the component will be read-only.

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ReadOnlyProps.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLUListElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`ListProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`ListProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ListProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`ListProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`ListProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`ListProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`ListProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`ListProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`ListProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`ListProps.style`

***

### subheader?[​](#subheader "Direct link to subheader?")

> `optional` **subheader**: `ReactNode`

The content of the subheader, normally `ListSubheader`.

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`ListProps.subheader`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`ListProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`ListProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`ListProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`ListProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`ListProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`ListProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`ListProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`ListProps.unselectable`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`ListProps.vocab`


---

# Interface: MuiRadioItemProps

Props for the MuiRadioItem component.

## Extends[​](#extends "Direct link to Extends")

* `Pick`<`RadioProps`, `"value"` | `"color"` | `"disabled"`>

## Properties[​](#properties "Direct link to Properties")

### color?[​](#color "Direct link to color?")

> `optional` **color**: `OverridableStringUnion`<`"error"` | `"default"` | `"success"` | `"primary"` | `"secondary"` | `"warning"` | `"info"`, `RadioPropsColorOverrides`>

The color of the component. It supports both default and custom theme colors, which can be added as shown in the [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).

#### Default[​](#default "Direct link to Default")

```
'primary'
```

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Pick.color`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If `true`, the component is disabled.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Pick.disabled`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the control.

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `unknown`

The value of the component. The DOM API casts this to a string.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Pick.value`


---

# Interface: MuiSelectProps

The MuiSelect component properties.

## Extends[​](#extends "Direct link to Extends")

* `Omit`<`SelectProps`<`string`>, `"onChange"`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Omit.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Omit.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Omit.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Omit.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`Omit.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`Omit.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`Omit.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`Omit.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`Omit.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`Omit.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`Omit.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`Omit.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`Omit.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`Omit.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`Omit.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`Omit.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`Omit.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`Omit.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`Omit.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`Omit.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`Omit.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`Omit.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`Omit.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`Omit.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`Omit.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`Omit.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`Omit.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`Omit.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`Omit.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`Omit.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`Omit.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`Omit.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`Omit.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`Omit.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`Omit.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`Omit.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`Omit.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`Omit.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`Omit.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`Omit.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`Omit.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`Omit.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`Omit.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`Omit.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`Omit.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`Omit.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`Omit.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`Omit.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`Omit.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`Omit.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`Omit.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`Omit.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`Omit.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`Omit.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`Omit.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`Omit.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `string`

This prop helps users to fill forms faster, especially on mobile devices. The name can be confusing, as it's more like an autofill. You can learn more about it [following the specification](https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill).

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`Omit.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`Omit.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

If `true`, the `input` element is focused during the first mount.

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`Omit.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`Omit.autoSave`

***

### autoWidth?[​](#autowidth "Direct link to autoWidth?")

> `optional` **autoWidth**: `boolean`

If `true`, the width of the popover will automatically be set according to the items inside the menu, otherwise it will be at least the width of the select input.

#### Default[​](#default "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`Omit.autoWidth`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The option elements to populate the select with. Can be some `MenuItem` when `native` is false and `option` when `native` is true.

⚠️The `MenuItem` elements **must** be direct descendants when `native` is false.

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`Omit.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`SelectClasses`>

Override or extend the styles applied to the component.

#### Default[​](#default-1 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`Omit.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`Omit.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `OverridableStringUnion`<`"error"` | `"success"` | `"primary"` | `"secondary"` | `"warning"` | `"info"`, `InputBasePropsColorOverrides`>

The color of the component. It supports both default and custom theme colors, which can be added as shown in the [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors). The prop defaults to the value (`'primary'`) inherited from the parent FormControl component.

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`Omit.color`

***

### ~~components?~~[​](#components "Direct link to components")

> `optional` **components**: `object`

The components used for each slot inside.

#### ~~Input?~~[​](#input "Direct link to input")

> `optional` **Input**: `ElementType`<`any`, keyof IntrinsicElements>

#### ~~Root?~~[​](#root "Direct link to root")

> `optional` **Root**: `ElementType`<`any`, keyof IntrinsicElements>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

use the `slots` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.

#### Default[​](#default-2 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`Omit.components`

***

### ~~componentsProps?~~[​](#componentsprops "Direct link to componentsprops")

> `optional` **componentsProps**: `object`

The extra props for the slot components. You can override the existing props or add new ones.

#### ~~input?~~[​](#input-1 "Direct link to input-1")

> `optional` **input**: `InputHTMLAttributes`<`HTMLInputElement`> & `InputBaseComponentsPropsOverrides`

#### ~~root?~~[​](#root-1 "Direct link to root-1")

> `optional` **root**: `HTMLAttributes`<`HTMLDivElement`> & `InputBaseComponentsPropsOverrides`

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

use the `slotProps` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.

#### Default[​](#default-3 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`Omit.componentsProps`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`Omit.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`Omit.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`Omit.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`Omit.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`Omit.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`Omit.defaultChecked`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

If `true`, the component is initially open. Use when the component open state is not controlled (i.e. the `open` prop is not defined). You can only use it when the `native` prop is `false` (default).

#### Default[​](#default-4 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`Omit.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string`

The default value. Use when the component is not controlled.

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`Omit.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`Omit.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If `true`, the component is disabled. The prop defaults to the value (`false`) inherited from the parent FormControl component.

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`Omit.disabled`

***

### disableInjectingGlobalStyles?[​](#disableinjectingglobalstyles "Direct link to disableInjectingGlobalStyles?")

> `optional` **disableInjectingGlobalStyles**: `boolean`

If `true`, GlobalStyles for the auto-fill keyframes will not be injected/removed on mount/unmount. Make sure to inject them at the top of your application. This option is intended to help with boosting the initial rendering performance if you are loading a big amount of Input components at once.

#### Default[​](#default-5 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`Omit.disableInjectingGlobalStyles`

***

### disableUnderline?[​](#disableunderline "Direct link to disableUnderline?")

> `optional` **disableUnderline**: `boolean`

If `true`, the input will not have an underline.

#### Default[​](#default-6 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`Omit.disableUnderline`

***

### displayEmpty?[​](#displayempty "Direct link to displayEmpty?")

> `optional` **displayEmpty**: `boolean`

If `true`, a value is displayed even if no items are selected.

In order to display a meaningful value, a function can be passed to the `renderValue` prop which returns the value to be displayed when no items are selected.

⚠️ When using this prop, make sure the label doesn't overlap with the empty displayed value. The label should either be hidden or forced to a shrunk state.

#### Default[​](#default-7 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`Omit.displayEmpty`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`Omit.draggable`

***

### endAdornment?[​](#endadornment "Direct link to endAdornment?")

> `optional` **endAdornment**: `ReactNode`

End `InputAdornment` for this component.

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`Omit.endAdornment`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`Omit.enterKeyHint`

***

### error?[​](#error "Direct link to error?")

> `optional` **error**: `boolean`

If `true`, the `input` will indicate an error. The prop defaults to the value (`false`) inherited from the parent FormControl component.

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`Omit.error`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`Omit.exportparts`

***

### fullWidth?[​](#fullwidth "Direct link to fullWidth?")

> `optional` **fullWidth**: `boolean`

If `true`, the `input` will take up the full width of its container.

#### Default[​](#default-8 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`Omit.fullWidth`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`Omit.hidden`

***

### IconComponent?[​](#iconcomponent "Direct link to IconComponent?")

> `optional` **IconComponent**: `ElementType`<`any`, keyof IntrinsicElements>

The icon that displays the arrow.

#### Default[​](#default-9 "Direct link to Default")

```
ArrowDropDownIcon
```

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`Omit.IconComponent`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The `id` of the wrapper element or the `select` element when `native`.

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`Omit.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`Omit.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`Omit.inlist`

***

### input?[​](#input-2 "Direct link to input?")

> `optional` **input**: `ReactElement`<`unknown`, `any`>

An `Input` element; does not have to be a material-ui specific `Input`.

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`Omit.input`

***

### inputComponent?[​](#inputcomponent "Direct link to inputComponent?")

> `optional` **inputComponent**: `ElementType`<`InputBaseComponentProps`, keyof IntrinsicElements>

The component used for the `input` element. Either a string to use a HTML element or a component.

#### Default[​](#default-10 "Direct link to Default")

```
'input'
```

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`Omit.inputComponent`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`Omit.inputMode`

***

### inputProps?[​](#inputprops "Direct link to inputProps?")

> `optional` **inputProps**: `InputBaseComponentProps`

[Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#attributes) applied to the `input` element. When `native` is `true`, the attributes are applied on the `select` element.

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`Omit.inputProps`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Pass a ref to the `input` element.

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`Omit.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`Omit.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`Omit.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`Omit.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`Omit.itemRef`

***

### items?[​](#items "Direct link to items?")

> `optional` **items**: [`LabeledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue)\[]

The select items.

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`Omit.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`Omit.itemType`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `ReactNode`

See [OutlinedInput#label](https://mui.com/material-ui/api/outlined-input/#props)

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`Omit.label`

***

### labelId?[​](#labelid "Direct link to labelId?")

> `optional` **labelId**: `string`

The ID of an element that acts as an additional label. The Select will be labelled by the additional label and the selected value.

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`Omit.labelId`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`Omit.lang`

***

### margin?[​](#margin "Direct link to margin?")

> `optional` **margin**: `"none"` | `"dense"`

If `dense`, will adjust vertical spacing. This is normally obtained via context from FormControl. The prop defaults to the value (`'none'`) inherited from the parent FormControl component.

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`Omit.margin`

***

### maxRows?[​](#maxrows "Direct link to maxRows?")

> `optional` **maxRows**: `string` | `number`

Maximum number of rows to display when multiline option is set to true.

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`Omit.maxRows`

***

### MenuProps?[​](#menuprops "Direct link to MenuProps?")

> `optional` **MenuProps**: `Partial`<`MenuProps`>

Props applied to the [`Menu`](https://mui.com/material-ui/api/menu/) element.

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`Omit.MenuProps`

***

### minRows?[​](#minrows "Direct link to minRows?")

> `optional` **minRows**: `string` | `number`

Minimum number of rows to display when multiline option is set to true.

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`Omit.minRows`

***

### multiline?[​](#multiline "Direct link to multiline?")

> `optional` **multiline**: `boolean`

If `true`, a [TextareaAutosize](https://mui.com/material-ui/react-textarea-autosize/) element is rendered.

#### Default[​](#default-11 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`Omit.multiline`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

If `true`, `value` must be an array and the menu will support multiple selections.

#### Default[​](#default-12 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`Omit.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name attribute of the `input` element.

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`Omit.name`

***

### native?[​](#native "Direct link to native?")

> `optional` **native**: `boolean`

If `true`, the component uses a native `select` element.

#### Default[​](#default-13 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`Omit.native`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`Omit.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`Omit.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`Omit.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`Omit.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`Omit.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`Omit.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`Omit.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`Omit.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`Omit.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`Omit.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`Omit.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`Omit.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`Omit.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`Omit.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement` | `HTMLTextAreaElement`>

Callback fired when the `input` is blurred.

Notice that the first argument (event) might be undefined.

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`Omit.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`Omit.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`Omit.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`Omit.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`Omit.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`Omit.onCanPlayThroughCapture`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`Omit.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`Omit.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`Omit.onClickCapture`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: (`event`) => `void`

Callback fired when the component requests to be closed. Use it in either controlled (see the `open` prop), or uncontrolled mode (to detect when the Select collapses).

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

The event source of the callback.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`Omit.onClose`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`Omit.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`Omit.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`Omit.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`Omit.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`Omit.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`Omit.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`Omit.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`Omit.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`Omit.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`Omit.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`Omit.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`Omit.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`Omit.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`Omit.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`Omit.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`Omit.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`Omit.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`Omit.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`Omit.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`Omit.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`Omit.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`Omit.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`Omit.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`Omit.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`Omit.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`Omit.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`Omit.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`Omit.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`Omit.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`Omit.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`Omit.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`Omit.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`Omit.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`Omit.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`Omit.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`Omit.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`Omit.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`Omit.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`Omit.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`Omit.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement` | `HTMLTextAreaElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`Omit.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`Omit.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`Omit.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`Omit.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`Omit.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`Omit.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement` | `HTMLTextAreaElement`>

Callback fired when the `input` doesn't satisfy its constraints.

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`Omit.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`Omit.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement` | `HTMLTextAreaElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`Omit.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`Omit.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-4 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`Omit.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-5 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`Omit.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement` | `HTMLTextAreaElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`Omit.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`Omit.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`Omit.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`Omit.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`Omit.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`Omit.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`Omit.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`Omit.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`Omit.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`Omit.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`Omit.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`Omit.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`Omit.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`Omit.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`Omit.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`Omit.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`Omit.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`Omit.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`Omit.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`Omit.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`Omit.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`Omit.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`Omit.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`Omit.onMouseUpCapture`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: (`event`) => `void`

Callback fired when the component requests to be opened. Use it in either controlled (see the `open` prop), or uncontrolled mode (to detect when the Select expands).

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event-1 "Direct link to event")

`SyntheticEvent`

The event source of the callback.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`Omit.onOpen`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`Omit.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`Omit.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`Omit.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`Omit.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`Omit.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`Omit.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`Omit.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`Omit.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`Omit.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`Omit.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`Omit.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`Omit.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`Omit.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`Omit.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`Omit.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`Omit.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`Omit.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`Omit.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`Omit.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`Omit.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`Omit.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`Omit.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`Omit.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`Omit.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`Omit.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`Omit.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`Omit.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`Omit.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`Omit.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`Omit.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`Omit.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`Omit.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`Omit.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`Omit.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`Omit.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`Omit.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`Omit.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`Omit.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`Omit.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`Omit.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`Omit.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`Omit.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`Omit.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`Omit.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`Omit.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`Omit.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`Omit.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`Omit.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`Omit.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`Omit.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`Omit.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`Omit.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`Omit.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`Omit.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`Omit.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`Omit.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`Omit.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`Omit.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`Omit.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`Omit.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`Omit.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`Omit.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`Omit.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`Omit.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`Omit.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`Omit.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`Omit.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`Omit.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`Omit.onWheelCapture`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

If `true`, the component is shown. You can only use it when the `native` prop is `false` (default).

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`Omit.open`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`Omit.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`Omit.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`Omit.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`Omit.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`Omit.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`Omit.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`Omit.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

It prevents the user from changing the value of the field (not from interacting with the field).

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`Omit.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `null` | (`instance`) => `void` | () => `VoidOrUndefinedOnly` | `RefObject`<`unknown`>

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`Omit.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`Omit.rel`

***

### renderSuffix()?[​](#rendersuffix "Direct link to renderSuffix()?")

> `optional` **renderSuffix**: (`state`) => `ReactNode`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### state[​](#state "Direct link to state")

###### disabled?[​](#disabled-1 "Direct link to disabled?")

`boolean`

###### error?[​](#error-1 "Direct link to error?")

`boolean`

###### filled?[​](#filled "Direct link to filled?")

`boolean`

###### focused?[​](#focused "Direct link to focused?")

`boolean`

###### margin?[​](#margin-1 "Direct link to margin?")

`"none"` | `"normal"` | `"dense"`

###### required?[​](#required "Direct link to required?")

`boolean`

###### startAdornment?[​](#startadornment "Direct link to startAdornment?")

`ReactNode`

#### Returns[​](#returns-2 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`Omit.renderSuffix`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`) => `ReactNode`

Render the selected value. You can only use it when the `native` prop is `false` (default).

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`string`

The `value` provided to the component.

#### Returns[​](#returns-3 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`Omit.renderValue`

***

### required?[​](#required-1 "Direct link to required?")

> `optional` **required**: `boolean`

If `true`, the `input` element is required. The prop defaults to the value (`false`) inherited from the parent FormControl component.

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`Omit.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`Omit.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`Omit.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`Omit.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`Omit.role`

***

### rows?[​](#rows "Direct link to rows?")

> `optional` **rows**: `string` | `number`

Number of rows to display when multiline option is set to true.

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`Omit.rows`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`Omit.security`

***

### SelectDisplayProps?[​](#selectdisplayprops "Direct link to SelectDisplayProps?")

> `optional` **SelectDisplayProps**: `HTMLAttributes`<`HTMLDivElement`>

Props applied to the clickable div element.

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`Omit.SelectDisplayProps`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `OverridableStringUnion`<`"small"` | `"medium"`, `InputBasePropsSizeOverrides`>

The size of the component.

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`Omit.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`Omit.slot`

***

### slotProps?[​](#slotprops "Direct link to slotProps?")

> `optional` **slotProps**: { `input?`: `InputHTMLAttributes`<`HTMLInputElement`> & `InputBaseComponentsPropsOverrides` & `object`; `root?`: `HTMLAttributes`<`HTMLDivElement`> & `InputBaseComponentsPropsOverrides` & `object`; } | `object` & `object`

The extra props for the slot components. You can override the existing props or add new ones.

This prop is an alias for the `componentsProps` prop, which will be deprecated in the future.

#### Default[​](#default-14 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`Omit.slotProps`

***

### slots?[​](#slots "Direct link to slots?")

> `optional` **slots**: { `input?`: `ElementType`<`any`, keyof IntrinsicElements>; `root?`: `ElementType`<`any`, keyof IntrinsicElements>; } | `Partial`<`OutlinedInputSlots`> & `object`

The components used for each slot inside.

This prop is an alias for the `components` prop, which will be deprecated in the future.

#### Default[​](#default-15 "Direct link to Default")

```
{}
```

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`Omit.slots`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`Omit.spellCheck`

***

### startAdornment?[​](#startadornment-1 "Direct link to startAdornment?")

> `optional` **startAdornment**: `ReactNode`

Start `InputAdornment` for this component.

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`Omit.startAdornment`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`Omit.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`Omit.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`Omit.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop that allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`Omit.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`Omit.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`Omit.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`Omit.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `string`

Type of the `input` element. It should be [a valid HTML5 input type](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).

#### Default[​](#default-16 "Direct link to Default")

```
'text'
```

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`Omit.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`Omit.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`Omit.unselectable`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `string`

The select value.

#### Overrides[​](#overrides "Direct link to Overrides")

`Omit.value`

***

### variant?[​](#variant "Direct link to variant?")

> `optional` **variant**: `"filled"` | `"outlined"` | `"standard"`

The variant to use.

#### Default[​](#default-17 "Direct link to Default")

```
'outlined'
```

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`Omit.variant`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`Omit.vocab`


---

# Interface: MuiStackProps

The MuiStack component properties.

## Extends[​](#extends "Direct link to Extends")

* `StackProps`.`DisabledProps`.`ReadOnlyProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`StackProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`StackProps.accessKey`

***

### alignContent?[​](#aligncontent "Direct link to alignContent?")

> `optional` **alignContent**: `ResponsiveStyleValue`\<readonly string\[] | AlignContent | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | AlignContent | undefined>

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`StackProps.alignContent`

***

### alignItems?[​](#alignitems "Direct link to alignItems?")

> `optional` **alignItems**: `ResponsiveStyleValue`\<readonly string\[] | AlignItems | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | AlignItems | undefined>

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`StackProps.alignItems`

***

### alignSelf?[​](#alignself "Direct link to alignSelf?")

> `optional` **alignSelf**: `ResponsiveStyleValue`\<readonly string\[] | AlignSelf | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | AlignSelf | undefined>

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`StackProps.alignSelf`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`StackProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`StackProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"both"` | `"inline"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`StackProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`StackProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`StackProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`StackProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`StackProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`StackProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`StackProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`StackProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`StackProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`StackProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"true"` | `"false"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`StackProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`StackProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`StackProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`StackProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`StackProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`StackProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`StackProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`StackProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`StackProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`StackProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"true"` | `"false"` | `"dialog"` | `"menu"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`StackProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`StackProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`StackProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`StackProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`StackProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`StackProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`StackProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`StackProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`StackProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`StackProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`StackProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`StackProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`StackProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`StackProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`StackProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`StackProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`StackProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`StackProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`StackProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`StackProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`StackProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`StackProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`StackProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`StackProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`StackProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`StackProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`StackProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`StackProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`StackProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`StackProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`StackProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`StackProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`StackProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`StackProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`StackProps.autoSave`

***

### bgcolor?[​](#bgcolor "Direct link to bgcolor?")

> `optional` **bgcolor**: `ResponsiveStyleValue`\<readonly string\[] | BackgroundColor | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | BackgroundColor | undefined>

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`StackProps.bgcolor`

***

### border?[​](#border "Direct link to border?")

> `optional` **border**: `ResponsiveStyleValue`<`undefined` | `number` | `"Menu"` | `"none"` | `"hidden"` | `string` & `object` | `"inset"` | `"red"` | `"-moz-initial"` | `"inherit"` | `"initial"` | `"revert"` | `"revert-layer"` | `"unset"` | `"aliceblue"` | `"antiquewhite"` | `"aqua"` | `"aquamarine"` | `"azure"` | `"beige"` | `"bisque"` | `"black"` | `"blanchedalmond"` | `"blue"` | `"blueviolet"` | `"brown"` | `"burlywood"` | `"cadetblue"` | `"chartreuse"` | `"chocolate"` | `"coral"` | `"cornflowerblue"` | `"cornsilk"` | `"crimson"` | `"cyan"` | `"darkblue"` | `"darkcyan"` | `"darkgoldenrod"` | `"darkgray"` | `"darkgreen"` | `"darkgrey"` | `"darkkhaki"` | `"darkmagenta"` | `"darkolivegreen"` | `"darkorange"` | `"darkorchid"` | `"darkred"` | `"darksalmon"` | `"darkseagreen"` | `"darkslateblue"` | `"darkslategray"` | `"darkslategrey"` | `"darkturquoise"` | `"darkviolet"` | `"deeppink"` | `"deepskyblue"` | `"dimgray"` | `"dimgrey"` | `"dodgerblue"` | `"firebrick"` | `"floralwhite"` | `"forestgreen"` | `"fuchsia"` | `"gainsboro"` | `"ghostwhite"` | `"gold"` | `"goldenrod"` | `"gray"` | `"green"` | `"greenyellow"` | `"grey"` | `"honeydew"` | `"hotpink"` | `"indianred"` | `"indigo"` | `"ivory"` | `"khaki"` | `"lavender"` | `"lavenderblush"` | `"lawngreen"` | `"lemonchiffon"` | `"lightblue"` | `"lightcoral"` | `"lightcyan"` | `"lightgoldenrodyellow"` | `"lightgray"` | `"lightgreen"` | `"lightgrey"` | `"lightpink"` | `"lightsalmon"` | `"lightseagreen"` | `"lightskyblue"` | `"lightslategray"` | `"lightslategrey"` | `"lightsteelblue"` | `"lightyellow"` | `"lime"` | `"limegreen"` | `"linen"` | `"magenta"` | `"maroon"` | `"mediumaquamarine"` | `"mediumblue"` | `"mediumorchid"` | `"mediumpurple"` | `"mediumseagreen"` | `"mediumslateblue"` | `"mediumspringgreen"` | `"mediumturquoise"` | `"mediumvioletred"` | `"midnightblue"` | `"mintcream"` | `"mistyrose"` | `"moccasin"` | `"navajowhite"` | `"navy"` | `"oldlace"` | `"olive"` | `"olivedrab"` | `"orange"` | `"orangered"` | `"orchid"` | `"palegoldenrod"` | `"palegreen"` | `"paleturquoise"` | `"palevioletred"` | `"papayawhip"` | `"peachpuff"` | `"peru"` | `"pink"` | `"plum"` | `"powderblue"` | `"purple"` | `"rebeccapurple"` | `"rosybrown"` | `"royalblue"` | `"saddlebrown"` | `"salmon"` | `"sandybrown"` | `"seagreen"` | `"seashell"` | `"sienna"` | `"silver"` | `"skyblue"` | `"slateblue"` | `"slategray"` | `"slategrey"` | `"snow"` | `"springgreen"` | `"steelblue"` | `"tan"` | `"teal"` | `"thistle"` | `"tomato"` | `"turquoise"` | `"violet"` | `"wheat"` | `"white"` | `"whitesmoke"` | `"yellow"` | `"yellowgreen"` | `"transparent"` | `"AccentColor"` | `"AccentColorText"` | `"ActiveText"` | `"ButtonBorder"` | `"ButtonFace"` | `"ButtonText"` | `"Canvas"` | `"CanvasText"` | `"Field"` | `"FieldText"` | `"GrayText"` | `"Highlight"` | `"HighlightText"` | `"LinkText"` | `"Mark"` | `"MarkText"` | `"SelectedItem"` | `"SelectedItemText"` | `"VisitedText"` | `"ActiveBorder"` | `"ActiveCaption"` | `"AppWorkspace"` | `"Background"` | `"ButtonHighlight"` | `"ButtonShadow"` | `"CaptionText"` | `"InactiveBorder"` | `"InactiveCaption"` | `"InactiveCaptionText"` | `"InfoBackground"` | `"InfoText"` | `"MenuText"` | `"Scrollbar"` | `"ThreeDDarkShadow"` | `"ThreeDFace"` | `"ThreeDHighlight"` | `"ThreeDLightShadow"` | `"ThreeDShadow"` | `"Window"` | `"WindowFrame"` | `"WindowText"` | `"currentColor"` | `"medium"` | `"dashed"` | `"dotted"` | `"double"` | `"groove"` | `"outset"` | `"ridge"` | `"solid"` | `"thick"` | `"thin"`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `number` | `"Menu"` | `"none"` | `"hidden"` | `string` & `object` | `"inset"` | `"red"` | `"-moz-initial"` | `"inherit"` | `"initial"` | `"revert"` | `"revert-layer"` | `"unset"` | `"aliceblue"` | `"antiquewhite"` | `"aqua"` | `"aquamarine"` | `"azure"` | `"beige"` | `"bisque"` | `"black"` | `"blanchedalmond"` | `"blue"` | `"blueviolet"` | `"brown"` | `"burlywood"` | `"cadetblue"` | `"chartreuse"` | `"chocolate"` | `"coral"` | `"cornflowerblue"` | `"cornsilk"` | `"crimson"` | `"cyan"` | `"darkblue"` | `"darkcyan"` | `"darkgoldenrod"` | `"darkgray"` | `"darkgreen"` | `"darkgrey"` | `"darkkhaki"` | `"darkmagenta"` | `"darkolivegreen"` | `"darkorange"` | `"darkorchid"` | `"darkred"` | `"darksalmon"` | `"darkseagreen"` | `"darkslateblue"` | `"darkslategray"` | `"darkslategrey"` | `"darkturquoise"` | `"darkviolet"` | `"deeppink"` | `"deepskyblue"` | `"dimgray"` | `"dimgrey"` | `"dodgerblue"` | `"firebrick"` | `"floralwhite"` | `"forestgreen"` | `"fuchsia"` | `"gainsboro"` | `"ghostwhite"` | `"gold"` | `"goldenrod"` | `"gray"` | `"green"` | `"greenyellow"` | `"grey"` | `"honeydew"` | `"hotpink"` | `"indianred"` | `"indigo"` | `"ivory"` | `"khaki"` | `"lavender"` | `"lavenderblush"` | `"lawngreen"` | `"lemonchiffon"` | `"lightblue"` | `"lightcoral"` | `"lightcyan"` | `"lightgoldenrodyellow"` | `"lightgray"` | `"lightgreen"` | `"lightgrey"` | `"lightpink"` | `"lightsalmon"` | `"lightseagreen"` | `"lightskyblue"` | `"lightslategray"` | `"lightslategrey"` | `"lightsteelblue"` | `"lightyellow"` | `"lime"` | `"limegreen"` | `"linen"` | `"magenta"` | `"maroon"` | `"mediumaquamarine"` | `"mediumblue"` | `"mediumorchid"` | `"mediumpurple"` | `"mediumseagreen"` | `"mediumslateblue"` | `"mediumspringgreen"` | `"mediumturquoise"` | `"mediumvioletred"` | `"midnightblue"` | `"mintcream"` | `"mistyrose"` | `"moccasin"` | `"navajowhite"` | `"navy"` | `"oldlace"` | `"olive"` | `"olivedrab"` | `"orange"` | `"orangered"` | `"orchid"` | `"palegoldenrod"` | `"palegreen"` | `"paleturquoise"` | `"palevioletred"` | `"papayawhip"` | `"peachpuff"` | `"peru"` | `"pink"` | `"plum"` | `"powderblue"` | `"purple"` | `"rebeccapurple"` | `"rosybrown"` | `"royalblue"` | `"saddlebrown"` | `"salmon"` | `"sandybrown"` | `"seagreen"` | `"seashell"` | `"sienna"` | `"silver"` | `"skyblue"` | `"slateblue"` | `"slategray"` | `"slategrey"` | `"snow"` | `"springgreen"` | `"steelblue"` | `"tan"` | `"teal"` | `"thistle"` | `"tomato"` | `"turquoise"` | `"violet"` | `"wheat"` | `"white"` | `"whitesmoke"` | `"yellow"` | `"yellowgreen"` | `"transparent"` | `"AccentColor"` | `"AccentColorText"` | `"ActiveText"` | `"ButtonBorder"` | `"ButtonFace"` | `"ButtonText"` | `"Canvas"` | `"CanvasText"` | `"Field"` | `"FieldText"` | `"GrayText"` | `"Highlight"` | `"HighlightText"` | `"LinkText"` | `"Mark"` | `"MarkText"` | `"SelectedItem"` | `"SelectedItemText"` | `"VisitedText"` | `"ActiveBorder"` | `"ActiveCaption"` | `"AppWorkspace"` | `"Background"` | `"ButtonHighlight"` | `"ButtonShadow"` | `"CaptionText"` | `"InactiveBorder"` | `"InactiveCaption"` | `"InactiveCaptionText"` | `"InfoBackground"` | `"InfoText"` | `"MenuText"` | `"Scrollbar"` | `"ThreeDDarkShadow"` | `"ThreeDFace"` | `"ThreeDHighlight"` | `"ThreeDLightShadow"` | `"ThreeDShadow"` | `"Window"` | `"WindowFrame"` | `"WindowText"` | `"currentColor"` | `"medium"` | `"dashed"` | `"dotted"` | `"double"` | `"groove"` | `"outset"` | `"ridge"` | `"solid"` | `"thick"` | `"thin"`>

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`StackProps.border`

***

### borderBottom?[​](#borderbottom "Direct link to borderBottom?")

> `optional` **borderBottom**: `ResponsiveStyleValue`\<BorderBottom\<string | number> | readonly NonNullable\<BorderBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderBottom\<string | number> | readonly NonNullable\<BorderBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`StackProps.borderBottom`

***

### borderColor?[​](#bordercolor "Direct link to borderColor?")

> `optional` **borderColor**: `ResponsiveStyleValue`\<readonly string\[] | BorderColor | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | BorderColor | undefined>

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`StackProps.borderColor`

***

### borderLeft?[​](#borderleft "Direct link to borderLeft?")

> `optional` **borderLeft**: `ResponsiveStyleValue`\<BorderLeft\<string | number> | readonly NonNullable\<BorderLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderLeft\<string | number> | readonly NonNullable\<BorderLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`StackProps.borderLeft`

***

### borderRadius?[​](#borderradius "Direct link to borderRadius?")

> `optional` **borderRadius**: `ResponsiveStyleValue`\<BorderRadius\<string | number> | readonly NonNullable\<BorderRadius\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderRadius\<string | number> | readonly NonNullable\<BorderRadius\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`StackProps.borderRadius`

***

### borderRight?[​](#borderright "Direct link to borderRight?")

> `optional` **borderRight**: `ResponsiveStyleValue`\<BorderRight\<string | number> | readonly NonNullable\<BorderRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderRight\<string | number> | readonly NonNullable\<BorderRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`StackProps.borderRight`

***

### borderTop?[​](#bordertop "Direct link to borderTop?")

> `optional` **borderTop**: `ResponsiveStyleValue`\<BorderTop\<string | number> | readonly NonNullable\<BorderTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BorderTop\<string | number> | readonly NonNullable\<BorderTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`StackProps.borderTop`

***

### bottom?[​](#bottom "Direct link to bottom?")

> `optional` **bottom**: `ResponsiveStyleValue`\<Bottom\<string | number> | readonly NonNullable\<Bottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Bottom\<string | number> | readonly NonNullable\<Bottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`StackProps.bottom`

***

### boxShadow?[​](#boxshadow "Direct link to boxShadow?")

> `optional` **boxShadow**: `ResponsiveStyleValue`\<number | BoxShadow | undefined> | (`theme`) => `ResponsiveStyleValue`\<number | BoxShadow | undefined>

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`StackProps.boxShadow`

***

### boxSizing?[​](#boxsizing "Direct link to boxSizing?")

> `optional` **boxSizing**: `ResponsiveStyleValue`\<BoxSizing | readonly NonNullable\<BoxSizing | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<BoxSizing | readonly NonNullable\<BoxSizing | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`StackProps.boxSizing`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The content of the component.

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`StackProps.children`

***

### classes?[​](#classes "Direct link to classes?")

> `optional` **classes**: `Partial`<`ClassNameMap`<`never`>>

Override or extend the styles applied to the component.

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`StackProps.classes`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`StackProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `ResponsiveStyleValue`\<readonly string\[] | Color | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Color | undefined>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`StackProps.color`

***

### columnGap?[​](#columngap "Direct link to columnGap?")

> `optional` **columnGap**: `ResponsiveStyleValue`\<ColumnGap\<string | number> | readonly NonNullable\<ColumnGap\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<ColumnGap\<string | number> | readonly NonNullable\<ColumnGap\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`StackProps.columnGap`

***

### component?[​](#component "Direct link to component?")

> `optional` **component**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`StackProps.component`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`StackProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`StackProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`StackProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`StackProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`StackProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`StackProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`StackProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`StackProps.dir`

***

### direction?[​](#direction "Direct link to direction?")

> `optional` **direction**: `ResponsiveStyleValue`<`"column"` | `"row"` | `"column-reverse"` | `"row-reverse"`>

Defines the `flex-direction` style property. It is applied for all screen sizes.

#### Default[​](#default "Direct link to Default")

```
'column'
```

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`StackProps.direction`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the component will be disabled.

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`DisabledProps.disabled`

***

### display?[​](#display "Direct link to display?")

> `optional` **display**: `ResponsiveStyleValue`\<readonly string\[] | Display | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Display | undefined>

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`StackProps.display`

***

### displayPrint?[​](#displayprint "Direct link to displayPrint?")

> `optional` **displayPrint**: `ResponsiveStyleValue`\<readonly string\[] | Display | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Display | undefined>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`StackProps.displayPrint`

***

### divider?[​](#divider "Direct link to divider?")

> `optional` **divider**: `ReactNode`

Add an element between each child.

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`StackProps.divider`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`StackProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`StackProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`StackProps.exportparts`

***

### flex?[​](#flex "Direct link to flex?")

> `optional` **flex**: `ResponsiveStyleValue`\<Flex\<string | number> | readonly NonNullable\<Flex\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Flex\<string | number> | readonly NonNullable\<Flex\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`StackProps.flex`

***

### flexBasis?[​](#flexbasis "Direct link to flexBasis?")

> `optional` **flexBasis**: `ResponsiveStyleValue`\<FlexBasis\<string | number> | readonly NonNullable\<FlexBasis\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexBasis\<string | number> | readonly NonNullable\<FlexBasis\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`StackProps.flexBasis`

***

### flexDirection?[​](#flexdirection "Direct link to flexDirection?")

> `optional` **flexDirection**: `ResponsiveStyleValue`\<FlexDirection | readonly NonNullable\<FlexDirection | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexDirection | readonly NonNullable\<FlexDirection | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`StackProps.flexDirection`

***

### flexGrow?[​](#flexgrow "Direct link to flexGrow?")

> `optional` **flexGrow**: `ResponsiveStyleValue`\<FlexGrow | readonly NonNullable\<FlexGrow | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexGrow | readonly NonNullable\<FlexGrow | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`StackProps.flexGrow`

***

### flexShrink?[​](#flexshrink "Direct link to flexShrink?")

> `optional` **flexShrink**: `ResponsiveStyleValue`\<FlexShrink | readonly NonNullable\<FlexShrink | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexShrink | readonly NonNullable\<FlexShrink | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`StackProps.flexShrink`

***

### flexWrap?[​](#flexwrap "Direct link to flexWrap?")

> `optional` **flexWrap**: `ResponsiveStyleValue`\<FlexWrap | readonly NonNullable\<FlexWrap | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FlexWrap | readonly NonNullable\<FlexWrap | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`StackProps.flexWrap`

***

### fontFamily?[​](#fontfamily "Direct link to fontFamily?")

> `optional` **fontFamily**: `ResponsiveStyleValue`\<readonly string\[] | FontFamily | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | FontFamily | undefined>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`StackProps.fontFamily`

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `ResponsiveStyleValue`\<FontSize\<string | number> | readonly NonNullable\<FontSize\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<FontSize\<string | number> | readonly NonNullable\<FontSize\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`StackProps.fontSize`

***

### fontStyle?[​](#fontstyle "Direct link to fontStyle?")

> `optional` **fontStyle**: `ResponsiveStyleValue`\<readonly string\[] | FontStyle | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | FontStyle | undefined>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`StackProps.fontStyle`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`StackProps.fontWeight`

***

### gap?[​](#gap "Direct link to gap?")

> `optional` **gap**: `ResponsiveStyleValue`\<Gap\<string | number> | readonly NonNullable\<Gap\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Gap\<string | number> | readonly NonNullable\<Gap\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`StackProps.gap`

***

### gridArea?[​](#gridarea "Direct link to gridArea?")

> `optional` **gridArea**: `ResponsiveStyleValue`\<GridArea | readonly NonNullable\<GridArea | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridArea | readonly NonNullable\<GridArea | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`StackProps.gridArea`

***

### gridAutoColumns?[​](#gridautocolumns "Direct link to gridAutoColumns?")

> `optional` **gridAutoColumns**: `ResponsiveStyleValue`\<GridAutoColumns\<string | number> | readonly NonNullable\<GridAutoColumns\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridAutoColumns\<string | number> | readonly NonNullable\<GridAutoColumns\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`StackProps.gridAutoColumns`

***

### gridAutoFlow?[​](#gridautoflow "Direct link to gridAutoFlow?")

> `optional` **gridAutoFlow**: `ResponsiveStyleValue`\<readonly string\[] | GridAutoFlow | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | GridAutoFlow | undefined>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`StackProps.gridAutoFlow`

***

### gridAutoRows?[​](#gridautorows "Direct link to gridAutoRows?")

> `optional` **gridAutoRows**: `ResponsiveStyleValue`\<GridAutoRows\<string | number> | readonly NonNullable\<GridAutoRows\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridAutoRows\<string | number> | readonly NonNullable\<GridAutoRows\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`StackProps.gridAutoRows`

***

### gridColumn?[​](#gridcolumn "Direct link to gridColumn?")

> `optional` **gridColumn**: `ResponsiveStyleValue`\<GridColumn | readonly NonNullable\<GridColumn | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridColumn | readonly NonNullable\<GridColumn | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`StackProps.gridColumn`

***

### gridRow?[​](#gridrow "Direct link to gridRow?")

> `optional` **gridRow**: `ResponsiveStyleValue`\<GridRow | readonly NonNullable\<GridRow | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridRow | readonly NonNullable\<GridRow | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`StackProps.gridRow`

***

### gridTemplateAreas?[​](#gridtemplateareas "Direct link to gridTemplateAreas?")

> `optional` **gridTemplateAreas**: `ResponsiveStyleValue`\<readonly string\[] | GridTemplateAreas | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | GridTemplateAreas | undefined>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`StackProps.gridTemplateAreas`

***

### gridTemplateColumns?[​](#gridtemplatecolumns "Direct link to gridTemplateColumns?")

> `optional` **gridTemplateColumns**: `ResponsiveStyleValue`\<GridTemplateColumns\<string | number> | readonly NonNullable\<GridTemplateColumns\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridTemplateColumns\<string | number> | readonly NonNullable\<GridTemplateColumns\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`StackProps.gridTemplateColumns`

***

### gridTemplateRows?[​](#gridtemplaterows "Direct link to gridTemplateRows?")

> `optional` **gridTemplateRows**: `ResponsiveStyleValue`\<GridTemplateRows\<string | number> | readonly NonNullable\<GridTemplateRows\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<GridTemplateRows\<string | number> | readonly NonNullable\<GridTemplateRows\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`StackProps.gridTemplateRows`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `ResponsiveStyleValue`\<Height\<string | number> | readonly NonNullable\<Height\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Height\<string | number> | readonly NonNullable\<Height\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`StackProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`StackProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`StackProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`StackProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`StackProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`StackProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`StackProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`StackProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`StackProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`StackProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`StackProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`StackProps.itemType`

***

### justifyContent?[​](#justifycontent "Direct link to justifyContent?")

> `optional` **justifyContent**: `ResponsiveStyleValue`\<readonly string\[] | JustifyContent | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | JustifyContent | undefined>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`StackProps.justifyContent`

***

### justifyItems?[​](#justifyitems "Direct link to justifyItems?")

> `optional` **justifyItems**: `ResponsiveStyleValue`\<readonly string\[] | JustifyItems | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | JustifyItems | undefined>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`StackProps.justifyItems`

***

### justifySelf?[​](#justifyself "Direct link to justifySelf?")

> `optional` **justifySelf**: `ResponsiveStyleValue`\<readonly string\[] | JustifySelf | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | JustifySelf | undefined>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`StackProps.justifySelf`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`StackProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`StackProps.lang`

***

### left?[​](#left "Direct link to left?")

> `optional` **left**: `ResponsiveStyleValue`\<Left\<string | number> | readonly NonNullable\<Left\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Left\<string | number> | readonly NonNullable\<Left\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`StackProps.left`

***

### letterSpacing?[​](#letterspacing "Direct link to letterSpacing?")

> `optional` **letterSpacing**: `ResponsiveStyleValue`\<LetterSpacing\<string | number> | readonly NonNullable\<LetterSpacing\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<LetterSpacing\<string | number> | readonly NonNullable\<LetterSpacing\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`StackProps.letterSpacing`

***

### lineHeight?[​](#lineheight "Direct link to lineHeight?")

> `optional` **lineHeight**: `ResponsiveStyleValue`\<LineHeight\<string | number> | readonly NonNullable\<LineHeight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<LineHeight\<string | number> | readonly NonNullable\<LineHeight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`StackProps.lineHeight`

***

### m?[​](#m "Direct link to m?")

> `optional` **m**: `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`StackProps.m`

***

### margin?[​](#margin "Direct link to margin?")

> `optional` **margin**: `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Margin\<string | number> | readonly NonNullable\<Margin\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`StackProps.margin`

***

### marginBlock?[​](#marginblock "Direct link to marginBlock?")

> `optional` **marginBlock**: `ResponsiveStyleValue`\<MarginBlock\<string | number> | readonly NonNullable\<MarginBlock\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBlock\<string | number> | readonly NonNullable\<MarginBlock\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`StackProps.marginBlock`

***

### marginBlockEnd?[​](#marginblockend "Direct link to marginBlockEnd?")

> `optional` **marginBlockEnd**: `ResponsiveStyleValue`\<MarginBlockEnd\<string | number> | readonly NonNullable\<MarginBlockEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBlockEnd\<string | number> | readonly NonNullable\<MarginBlockEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`StackProps.marginBlockEnd`

***

### marginBlockStart?[​](#marginblockstart "Direct link to marginBlockStart?")

> `optional` **marginBlockStart**: `ResponsiveStyleValue`\<MarginBlockStart\<string | number> | readonly NonNullable\<MarginBlockStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBlockStart\<string | number> | readonly NonNullable\<MarginBlockStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`StackProps.marginBlockStart`

***

### marginBottom?[​](#marginbottom "Direct link to marginBottom?")

> `optional` **marginBottom**: `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`StackProps.marginBottom`

***

### marginInline?[​](#margininline "Direct link to marginInline?")

> `optional` **marginInline**: `ResponsiveStyleValue`\<MarginInline\<string | number> | readonly NonNullable\<MarginInline\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginInline\<string | number> | readonly NonNullable\<MarginInline\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`StackProps.marginInline`

***

### marginInlineEnd?[​](#margininlineend "Direct link to marginInlineEnd?")

> `optional` **marginInlineEnd**: `ResponsiveStyleValue`\<MarginInlineEnd\<string | number> | readonly NonNullable\<MarginInlineEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginInlineEnd\<string | number> | readonly NonNullable\<MarginInlineEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`StackProps.marginInlineEnd`

***

### marginInlineStart?[​](#margininlinestart "Direct link to marginInlineStart?")

> `optional` **marginInlineStart**: `ResponsiveStyleValue`\<MarginInlineStart\<string | number> | readonly NonNullable\<MarginInlineStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginInlineStart\<string | number> | readonly NonNullable\<MarginInlineStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`StackProps.marginInlineStart`

***

### marginLeft?[​](#marginleft "Direct link to marginLeft?")

> `optional` **marginLeft**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`StackProps.marginLeft`

***

### marginRight?[​](#marginright "Direct link to marginRight?")

> `optional` **marginRight**: `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`StackProps.marginRight`

***

### marginTop?[​](#margintop "Direct link to marginTop?")

> `optional` **marginTop**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`StackProps.marginTop`

***

### marginX?[​](#marginx "Direct link to marginX?")

> `optional` **marginX**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`StackProps.marginX`

***

### marginY?[​](#marginy "Direct link to marginY?")

> `optional` **marginY**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`StackProps.marginY`

***

### maxHeight?[​](#maxheight "Direct link to maxHeight?")

> `optional` **maxHeight**: `ResponsiveStyleValue`\<MaxHeight\<string | number> | readonly NonNullable\<MaxHeight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MaxHeight\<string | number> | readonly NonNullable\<MaxHeight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`StackProps.maxHeight`

***

### maxWidth?[​](#maxwidth "Direct link to maxWidth?")

> `optional` **maxWidth**: `ResponsiveStyleValue`\<MaxWidth\<string | number> | readonly NonNullable\<MaxWidth\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MaxWidth\<string | number> | readonly NonNullable\<MaxWidth\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`StackProps.maxWidth`

***

### mb?[​](#mb "Direct link to mb?")

> `optional` **mb**: `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginBottom\<string | number> | readonly NonNullable\<MarginBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`StackProps.mb`

***

### minHeight?[​](#minheight "Direct link to minHeight?")

> `optional` **minHeight**: `ResponsiveStyleValue`\<MinHeight\<string | number> | readonly NonNullable\<MinHeight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MinHeight\<string | number> | readonly NonNullable\<MinHeight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`StackProps.minHeight`

***

### minWidth?[​](#minwidth "Direct link to minWidth?")

> `optional` **minWidth**: `ResponsiveStyleValue`\<MinWidth\<string | number> | readonly NonNullable\<MinWidth\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MinWidth\<string | number> | readonly NonNullable\<MinWidth\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`StackProps.minWidth`

***

### ml?[​](#ml "Direct link to ml?")

> `optional` **ml**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`StackProps.ml`

***

### mr?[​](#mr "Direct link to mr?")

> `optional` **mr**: `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginRight\<string | number> | readonly NonNullable\<MarginRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`StackProps.mr`

***

### mt?[​](#mt "Direct link to mt?")

> `optional` **mt**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`StackProps.mt`

***

### mx?[​](#mx "Direct link to mx?")

> `optional` **mx**: `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginLeft\<string | number> | readonly NonNullable\<MarginLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`StackProps.mx`

***

### my?[​](#my "Direct link to my?")

> `optional` **my**: `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<MarginTop\<string | number> | readonly NonNullable\<MarginTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`StackProps.my`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`StackProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`StackProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`StackProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`StackProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`StackProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`StackProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`StackProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`StackProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`StackProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`StackProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`StackProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`StackProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`StackProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`StackProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`StackProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`StackProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`StackProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`StackProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`StackProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`StackProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`StackProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`StackProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`StackProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`StackProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`StackProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`StackProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`StackProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`StackProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`StackProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`StackProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`StackProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`StackProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`StackProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`StackProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`StackProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`StackProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`StackProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`StackProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`StackProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`StackProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`StackProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`StackProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`StackProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`StackProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`StackProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`StackProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`StackProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`StackProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`StackProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`StackProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`StackProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`StackProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`StackProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`StackProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`StackProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`StackProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`StackProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`StackProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`StackProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`StackProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`StackProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`StackProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`StackProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`StackProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`StackProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`StackProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`StackProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`StackProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`StackProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`StackProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`StackProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`StackProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`StackProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`StackProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`StackProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`StackProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`StackProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`StackProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`StackProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`StackProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`StackProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`StackProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`StackProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`StackProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`StackProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`StackProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`StackProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`StackProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`StackProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`StackProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`StackProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`StackProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`StackProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`StackProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`StackProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`StackProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`StackProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`StackProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`StackProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`StackProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`StackProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`StackProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`StackProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`StackProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`StackProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`StackProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`StackProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`StackProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`StackProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`StackProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`StackProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`StackProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`StackProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`StackProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`StackProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`StackProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`StackProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`StackProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`StackProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`StackProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`StackProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`StackProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`StackProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`StackProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`StackProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`StackProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`StackProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`StackProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`StackProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`StackProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`StackProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`StackProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`StackProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`StackProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`StackProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`StackProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`StackProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`StackProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`StackProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`StackProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`StackProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`StackProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`StackProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`StackProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`StackProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`StackProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`StackProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`StackProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`StackProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`StackProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`StackProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`StackProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`StackProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`StackProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`StackProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`StackProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`StackProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`StackProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`StackProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`StackProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`StackProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`StackProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`StackProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-322 "Direct link to Inherited from")

`StackProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-323 "Direct link to Inherited from")

`StackProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-324 "Direct link to Inherited from")

`StackProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-325 "Direct link to Inherited from")

`StackProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-326 "Direct link to Inherited from")

`StackProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLDivElement`>

#### Inherited from[​](#inherited-from-327 "Direct link to Inherited from")

`StackProps.onWheelCapture`

***

### order?[​](#order "Direct link to order?")

> `optional` **order**: `ResponsiveStyleValue`\<Order | readonly NonNullable\<Order | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Order | readonly NonNullable\<Order | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-328 "Direct link to Inherited from")

`StackProps.order`

***

### overflow?[​](#overflow "Direct link to overflow?")

> `optional` **overflow**: `ResponsiveStyleValue`\<readonly string\[] | Overflow | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | Overflow | undefined>

#### Inherited from[​](#inherited-from-329 "Direct link to Inherited from")

`StackProps.overflow`

***

### p?[​](#p "Direct link to p?")

> `optional` **p**: `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-330 "Direct link to Inherited from")

`StackProps.p`

***

### padding?[​](#padding "Direct link to padding?")

> `optional` **padding**: `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Padding\<string | number> | readonly NonNullable\<Padding\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-331 "Direct link to Inherited from")

`StackProps.padding`

***

### paddingBlock?[​](#paddingblock "Direct link to paddingBlock?")

> `optional` **paddingBlock**: `ResponsiveStyleValue`\<PaddingBlock\<string | number> | readonly NonNullable\<PaddingBlock\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBlock\<string | number> | readonly NonNullable\<PaddingBlock\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-332 "Direct link to Inherited from")

`StackProps.paddingBlock`

***

### paddingBlockEnd?[​](#paddingblockend "Direct link to paddingBlockEnd?")

> `optional` **paddingBlockEnd**: `ResponsiveStyleValue`\<PaddingBlockEnd\<string | number> | readonly NonNullable\<PaddingBlockEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBlockEnd\<string | number> | readonly NonNullable\<PaddingBlockEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-333 "Direct link to Inherited from")

`StackProps.paddingBlockEnd`

***

### paddingBlockStart?[​](#paddingblockstart "Direct link to paddingBlockStart?")

> `optional` **paddingBlockStart**: `ResponsiveStyleValue`\<PaddingBlockStart\<string | number> | readonly NonNullable\<PaddingBlockStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBlockStart\<string | number> | readonly NonNullable\<PaddingBlockStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-334 "Direct link to Inherited from")

`StackProps.paddingBlockStart`

***

### paddingBottom?[​](#paddingbottom "Direct link to paddingBottom?")

> `optional` **paddingBottom**: `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-335 "Direct link to Inherited from")

`StackProps.paddingBottom`

***

### paddingInline?[​](#paddinginline "Direct link to paddingInline?")

> `optional` **paddingInline**: `ResponsiveStyleValue`\<PaddingInline\<string | number> | readonly NonNullable\<PaddingInline\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingInline\<string | number> | readonly NonNullable\<PaddingInline\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-336 "Direct link to Inherited from")

`StackProps.paddingInline`

***

### paddingInlineEnd?[​](#paddinginlineend "Direct link to paddingInlineEnd?")

> `optional` **paddingInlineEnd**: `ResponsiveStyleValue`\<PaddingInlineEnd\<string | number> | readonly NonNullable\<PaddingInlineEnd\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingInlineEnd\<string | number> | readonly NonNullable\<PaddingInlineEnd\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-337 "Direct link to Inherited from")

`StackProps.paddingInlineEnd`

***

### paddingInlineStart?[​](#paddinginlinestart "Direct link to paddingInlineStart?")

> `optional` **paddingInlineStart**: `ResponsiveStyleValue`\<PaddingInlineStart\<string | number> | readonly NonNullable\<PaddingInlineStart\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingInlineStart\<string | number> | readonly NonNullable\<PaddingInlineStart\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-338 "Direct link to Inherited from")

`StackProps.paddingInlineStart`

***

### paddingLeft?[​](#paddingleft "Direct link to paddingLeft?")

> `optional` **paddingLeft**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-339 "Direct link to Inherited from")

`StackProps.paddingLeft`

***

### paddingRight?[​](#paddingright "Direct link to paddingRight?")

> `optional` **paddingRight**: `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-340 "Direct link to Inherited from")

`StackProps.paddingRight`

***

### paddingTop?[​](#paddingtop "Direct link to paddingTop?")

> `optional` **paddingTop**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-341 "Direct link to Inherited from")

`StackProps.paddingTop`

***

### paddingX?[​](#paddingx "Direct link to paddingX?")

> `optional` **paddingX**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-342 "Direct link to Inherited from")

`StackProps.paddingX`

***

### paddingY?[​](#paddingy "Direct link to paddingY?")

> `optional` **paddingY**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-343 "Direct link to Inherited from")

`StackProps.paddingY`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-344 "Direct link to Inherited from")

`StackProps.part`

***

### pb?[​](#pb "Direct link to pb?")

> `optional` **pb**: `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingBottom\<string | number> | readonly NonNullable\<PaddingBottom\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-345 "Direct link to Inherited from")

`StackProps.pb`

***

### pl?[​](#pl "Direct link to pl?")

> `optional` **pl**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-346 "Direct link to Inherited from")

`StackProps.pl`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-347 "Direct link to Inherited from")

`StackProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-348 "Direct link to Inherited from")

`StackProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-349 "Direct link to Inherited from")

`StackProps.popoverTargetAction`

***

### position?[​](#position "Direct link to position?")

> `optional` **position**: `ResponsiveStyleValue`\<Position | readonly NonNullable\<Position | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Position | readonly NonNullable\<Position | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-350 "Direct link to Inherited from")

`StackProps.position`

***

### pr?[​](#pr "Direct link to pr?")

> `optional` **pr**: `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingRight\<string | number> | readonly NonNullable\<PaddingRight\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-351 "Direct link to Inherited from")

`StackProps.pr`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-352 "Direct link to Inherited from")

`StackProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-353 "Direct link to Inherited from")

`StackProps.property`

***

### pt?[​](#pt "Direct link to pt?")

> `optional` **pt**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-354 "Direct link to Inherited from")

`StackProps.pt`

***

### px?[​](#px "Direct link to px?")

> `optional` **px**: `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingLeft\<string | number> | readonly NonNullable\<PaddingLeft\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-355 "Direct link to Inherited from")

`StackProps.px`

***

### py?[​](#py "Direct link to py?")

> `optional` **py**: `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<PaddingTop\<string | number> | readonly NonNullable\<PaddingTop\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-356 "Direct link to Inherited from")

`StackProps.py`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-357 "Direct link to Inherited from")

`StackProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the component will be read-only.

#### Inherited from[​](#inherited-from-358 "Direct link to Inherited from")

`ReadOnlyProps.readOnly`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLDivElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-359 "Direct link to Inherited from")

`StackProps.ref`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-360 "Direct link to Inherited from")

`StackProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-361 "Direct link to Inherited from")

`StackProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-362 "Direct link to Inherited from")

`StackProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-363 "Direct link to Inherited from")

`StackProps.rev`

***

### right?[​](#right "Direct link to right?")

> `optional` **right**: `ResponsiveStyleValue`\<Right\<string | number> | readonly NonNullable\<Right\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Right\<string | number> | readonly NonNullable\<Right\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-364 "Direct link to Inherited from")

`StackProps.right`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-365 "Direct link to Inherited from")

`StackProps.role`

***

### rowGap?[​](#rowgap "Direct link to rowGap?")

> `optional` **rowGap**: `ResponsiveStyleValue`\<RowGap\<string | number> | readonly NonNullable\<RowGap\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<RowGap\<string | number> | readonly NonNullable\<RowGap\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-366 "Direct link to Inherited from")

`StackProps.rowGap`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-367 "Direct link to Inherited from")

`StackProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-368 "Direct link to Inherited from")

`StackProps.slot`

***

### spacing?[​](#spacing "Direct link to spacing?")

> `optional` **spacing**: `ResponsiveStyleValue`<`string` | `number`>

Defines the space between immediate children.

#### Default[​](#default-1 "Direct link to Default")

```
0
```

#### Inherited from[​](#inherited-from-369 "Direct link to Inherited from")

`StackProps.spacing`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-370 "Direct link to Inherited from")

`StackProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-371 "Direct link to Inherited from")

`StackProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-372 "Direct link to Inherited from")

`StackProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-373 "Direct link to Inherited from")

`StackProps.suppressHydrationWarning`

***

### sx?[​](#sx "Direct link to sx?")

> `optional` **sx**: `SxProps`<`Theme`>

The system prop, which allows defining system overrides as well as additional CSS styles.

#### Inherited from[​](#inherited-from-374 "Direct link to Inherited from")

`StackProps.sx`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-375 "Direct link to Inherited from")

`StackProps.tabIndex`

***

### textAlign?[​](#textalign "Direct link to textAlign?")

> `optional` **textAlign**: `ResponsiveStyleValue`\<TextAlign | readonly NonNullable\<TextAlign | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<TextAlign | readonly NonNullable\<TextAlign | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-376 "Direct link to Inherited from")

`StackProps.textAlign`

***

### textOverflow?[​](#textoverflow "Direct link to textOverflow?")

> `optional` **textOverflow**: `ResponsiveStyleValue`\<readonly string\[] | TextOverflow | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | TextOverflow | undefined>

#### Inherited from[​](#inherited-from-377 "Direct link to Inherited from")

`StackProps.textOverflow`

***

### textTransform?[​](#texttransform "Direct link to textTransform?")

> `optional` **textTransform**: `ResponsiveStyleValue`\<readonly string\[] | TextTransform | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | TextTransform | undefined>

#### Inherited from[​](#inherited-from-378 "Direct link to Inherited from")

`StackProps.textTransform`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-379 "Direct link to Inherited from")

`StackProps.title`

***

### top?[​](#top "Direct link to top?")

> `optional` **top**: `ResponsiveStyleValue`\<Top\<string | number> | readonly NonNullable\<Top\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Top\<string | number> | readonly NonNullable\<Top\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-380 "Direct link to Inherited from")

`StackProps.top`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-381 "Direct link to Inherited from")

`StackProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-382 "Direct link to Inherited from")

`StackProps.typeof`

***

### typography?[​](#typography "Direct link to typography?")

> `optional` **typography**: `ResponsiveStyleValue`<`undefined` | `string`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `string`>

#### Inherited from[​](#inherited-from-383 "Direct link to Inherited from")

`StackProps.typography`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-384 "Direct link to Inherited from")

`StackProps.unselectable`

***

### useFlexGap?[​](#useflexgap "Direct link to useFlexGap?")

> `optional` **useFlexGap**: `boolean`

If `true`, the CSS flexbox `gap` is used instead of applying `margin` to children.

While CSS `gap` removes the [known limitations](https://mui.com/joy-ui/react-stack/#limitations), it is not fully supported in some browsers. We recommend checking <https://caniuse.com/?search=flex%20gap> before using this flag.

To enable this flag globally, follow the [theme's default props](https://mui.com/material-ui/customization/theme-components/#default-props) configuration.

#### Default[​](#default-2 "Direct link to Default")

```
false
```

#### Inherited from[​](#inherited-from-385 "Direct link to Inherited from")

`StackProps.useFlexGap`

***

### visibility?[​](#visibility "Direct link to visibility?")

> `optional` **visibility**: `ResponsiveStyleValue`\<Visibility | readonly NonNullable\<Visibility | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Visibility | readonly NonNullable\<Visibility | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-386 "Direct link to Inherited from")

`StackProps.visibility`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-387 "Direct link to Inherited from")

`StackProps.vocab`

***

### whiteSpace?[​](#whitespace "Direct link to whiteSpace?")

> `optional` **whiteSpace**: `ResponsiveStyleValue`\<readonly string\[] | WhiteSpace | undefined> | (`theme`) => `ResponsiveStyleValue`\<readonly string\[] | WhiteSpace | undefined>

#### Inherited from[​](#inherited-from-388 "Direct link to Inherited from")

`StackProps.whiteSpace`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `ResponsiveStyleValue`\<Width\<string | number> | readonly NonNullable\<Width\<string | number> | undefined>\[] | undefined> | (`theme`) => `ResponsiveStyleValue`\<Width\<string | number> | readonly NonNullable\<Width\<string | number> | undefined>\[] | undefined>

#### Inherited from[​](#inherited-from-389 "Direct link to Inherited from")

`StackProps.width`

***

### zIndex?[​](#zindex "Direct link to zIndex?")

> `optional` **zIndex**: `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`> | (`theme`) => `ResponsiveStyleValue`<`undefined` | `string` | `string` & `object` | `number` & `object`>

#### Inherited from[​](#inherited-from-390 "Direct link to Inherited from")

`StackProps.zIndex`


---

# Interface: MuiSwitchProps

Props for the MuiSwitch component.

## Extends[​](#extends "Direct link to Extends")

* `Pick`<`SwitchProps`, `"checked"` | `"color"` | `"disabled"` | `"size"`>

## Properties[​](#properties "Direct link to Properties")

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

If `true`, the component is checked.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Pick.checked`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `OverridableStringUnion`<`"error"` | `"default"` | `"success"` | `"primary"` | `"secondary"` | `"warning"` | `"info"`, `SwitchPropsColorOverrides`>

The color of the component. It supports both default and custom theme colors, which can be added as shown in the [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).

#### Default[​](#default "Direct link to Default")

```
'primary'
```

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Pick.color`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If `true`, the component is disabled.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Pick.disabled`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the radio checkbox.

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`checked?`) => `void`

Callback fired when the checkbox state changes.

#### Parameters[​](#parameters "Direct link to Parameters")

##### checked?[​](#checked-1 "Direct link to checked?")

`boolean`

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `OverridableStringUnion`<`"small"` | `"medium"`, `SwitchPropsSizeOverrides`>

The size of the component. `small` is equivalent to the dense switch styling.

#### Default[​](#default-1 "Direct link to Default")

```
'medium'
```

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Pick.size`


---

# Type Alias: MuiTextFieldProps

> **MuiTextFieldProps** = `ComponentProps`<*typeof* `TextField`> & `object`

Props for the MuiTextField component.

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Callback function when the text field value changes.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`string`

#### Returns[​](#returns "Direct link to Returns")

`void`

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the form control will be read-only.


---

# Variable: builderView

> `const` **builderView**: [`BuilderView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView)

An assembled set of Material UI components metadata, ready to be passed as a property to the FormBuilder.


---

# Variable: components

> `const` **components**: [`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)\[]


---

# Variable: materialUiComponentsDescriptions

> `const` **materialUiComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: models

> `const` **models**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

An array of Material UI component metadata for use in FormViewer.


---

# Variable: muiArEgComponentsDescriptions

> **muiArEgComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"عرض البيانات"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"ردود الفعل"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"شكل"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"المدخلات"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"تخطيط"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"الملاحة"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"الأسطح"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"إذا كان هذا صحيحا ، يتم فحص المكون"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"فحص"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"محتوى المكون"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"الأطفال"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"لون المكون"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"اللون"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"القيمة الافتراضية. استخدم عندما لا يتم التحكم في المكون"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"القيمة الافتراضية"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"إذا كان هذا صحيحا ، يقلل من الحشو العمودي"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"كثيفة"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"إذا كان هذا صحيحا ، يتم تعطيل المكون"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"معاق"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"إذا كان هذا صحيحا ، فقم بتعطيل الحشو الأيمن والأيسر"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"تعطيل المزاريب"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"إذا كان هذا صحيحا ، قم بتعطيل الحشو الافتراضي"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"تعطيل الحشو"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"إذا كان هذا صحيحا ، يتم عرض المكون في حالة خطأ"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"خطأ"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"إذا كان هذا صحيحا ، فإن المكون يأخذ العرض الكامل للحاوية الخاصة به"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"العرض الكامل"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"إذا كان هذا صحيحا ، فسيكون للنص هامش سفلي"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"مزراب أسفل"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"محتوى النص المساعد"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"نص مساعد"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"يحدد الهامش المطبق على المكون"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"الهامش"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"إذا كان هذا صحيحا ، فلن يتم التفاف النص ، ولكن بدلا من ذلك سيتم اقتطاعه باستخدام علامة حذف تجاوز سعة النص"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"لا التفاف"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"رد أطلقت عندما يتم تغيير القيمة"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"أونشانج"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"تم تشغيل رد الاتصال عند النقر فوق المكون"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"أونكليك"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"إذا كان هذا صحيحا ، فإن عنصر الإدخال مطلوب"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"مطلوب"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"حجم المكون"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"الحجم"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"دعامة النظام التي تسمح بتعريف تجاوزات النظام بالإضافة إلى أنماط كس الإضافية"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"سك"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"محاذاة النص"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"المحاذاة"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"قيمة المكون"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"القيمة"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"البديل للاستخدام"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"البديل"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"حاوية تخطيط عام مع دعم تصميم النظام"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"صندوق"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"يعرض موقع الصفحة الحالي ضمن تسلسل هرمي"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"فتات الخبز"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"عناصر مسار التنقل لعرضها"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"البنود"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"إذا تم تجاوز الحد الأقصى للعناصر ، فإن عدد العناصر المراد إظهارها بعد علامة القطع"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"العناصر بعد الانهيار"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"إذا تم تجاوز الحد الأقصى للعناصر ، فإن عدد العناصر المراد إظهارها قبل علامة القطع"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"العناصر قبل الانهيار"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"يحدد الحد الأقصى لعدد فتات الخبز لعرضه"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"ماكس البنود"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"العنصر المستخدم لفصل عناصر مسار التنقل"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"فاصل"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"مكون زر يستخدم لتشغيل الإجراءات أو الأحداث"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"زر"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"التسمية التوضيحية"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"المحتوى"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"يزيل ظل الزر عند ضبطه على صحيح"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"تعطيل الارتفاع"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"يعرض مؤشر تحميل ويعطل التفاعل"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"تحميل"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"مجموعات الأزرار ذات الصلة معا"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"مجموعة الأزرار"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"يجعل مجموعة الأزرار تمتد بعرض الحاوية الكامل"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"العرض الكامل"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"يحدد اتجاه تخطيط الأزرار"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"التوجيه"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"مكون السطح لتجميع المحتوى ذي الصلة"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"بطاقة"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"أزرار الإجراءات أو عناصر التحكم للبطاقة"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"الإجراءات"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"المحتوى المقدم في رأس البطاقة"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"رأس"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"عنصر الإجراء المعروض في الرأس"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"إجراء الرأس"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"عنصر الصورة الرمزية المعروض في الرأس"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"رأس الصورة الرمزية"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"محتوى الوسائط مثل صورة أو فيديو"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"وسائل الإعلام"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"يتم تشغيل رد الاتصال عند تحديد البطاقة"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"أونسيلكت"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"النص الثانوي المعروض أسفل الرأس"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"رأس فرعي"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"يعرض قسم الإجراءات في الأسفل"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"استخدام الإجراءات"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"يلتف المحتوى مع منطقة عمل قابلة للنقر"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"استخدم منطقة عمل البطاقة"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"تمكين قسم رأس البطاقة"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"استخدام رأس"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"تمكين منطقة عمل داخل الرأس"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"استخدم إجراء الرأس"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"يعرض الصورة الرمزية داخل الرأس"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"استخدم الصورة الرمزية للرأس"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"تمكين قسم الوسائط داخل البطاقة"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"استخدام الوسائط"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"يعرض رأس فرعي أسفل الرأس الرئيسي"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"استخدم العنوان الفرعي"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"يسمح بتحديد خيار واحد أو أكثر"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"خانة الاختيار"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"حالة التحقق الأولية عندما لا يمكن السيطرة عليها"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"التحقق الافتراضي"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"يشير إلى التحميل أو التقدم في شكل دائري"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"التقدم الدائري"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"تعطيل الرسوم المتحركة يتقلص"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"تعطيل الانكماش"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"يتحكم في عرض السكتة الدماغية للدائرة"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"سمك"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"مراكز ويقيد المحتوى أفقيا"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"حاوية"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"يحدد أقصى عرض ثابت بدلا من عرض سائل"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"ثابت"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"يحدد الحد الأقصى لعرض الحاوية"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"أقصى عرض"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"يلف المحتوى ويعرض حالة خطأ أو رسالة"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"خطأ المجمع"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"يربط التسمية مع عنصر تحكم النموذج"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"تسمية التحكم في النموذج"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"عنصر التحكم في النموذج (مربع الاختيار ، الراديو ، التبديل)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"التحكم"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"موقف التسمية نسبة إلى السيطرة"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"وضع التسمية"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"تسمية لتجميع أو وصف حقول النموذج"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"تسمية النموذج"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"يطبق تصميم الحالة المملوءة"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"شغل"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"يشير إلى التحميل أو التقدم في شريط خطي"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"التقدم الخطي"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"قيمة المخزن المؤقت الثانوي لوضع التقدم المخزن مؤقتا"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"قيمة المخزن المؤقت"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"عنصر قابل للنقر للتنقل أو الإجراءات"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"الرابط"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"عنوان الوجهة"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"هريف"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"يعرض قائمة عمودية من العناصر"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"قائمة"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"يمثل عنصر واحد داخل قائمة"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"عنصر القائمة"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"يعرض مقسم أسفل عنصر القائمة"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"مقسم"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"يسمح بتحديد خيار واحد من مجموعة"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"مجموعة راديو"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"اسم السمة المستخدمة لمجموعة أزرار الاختيار"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"الاسم"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"يعرض أزرار الراديو أفقيا"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"صف"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"زر اختيار واحد يستخدم داخل مجموعة راديو"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"عنصر الراديو"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"مكون القائمة المنسدلة لاختيار الخيارات"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"اختر"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"يركز تلقائيا الحقل على جبل"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"التركيز التلقائي"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"يسمح بتحديد خيارات متعددة"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"متعددة"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"تخطيطات الأطفال في كومة أحادية البعد"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"المكدس"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"يتحكم في محاذاة المحور المتقاطع"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"محاذاة العناصر"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"يحدد ما إذا كانت العناصر مكدسة في صف أو عمود"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"الاتجاه"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"يتحكم في ما إذا كانت العناصر تلتف على أسطر متعددة"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"فليكس التفاف"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"يتحكم في محاذاة المحور الرئيسي"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"تبرير المحتوى"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"التباعد بين العناصر المكدسة"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"التباعد"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"يستخدم فجوة كس بدلا من الهوامش للتباعد"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"استخدام فليكس الفجوة"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"تبديل التحكم للتبديل بين دولتين"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"التبديل"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"حالة التبديل الأولية عندما لا يمكن السيطرة عليها"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"التحقق الافتراضي"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"حقل الإدخال للنص وبيانات النموذج"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"حقل النص"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"يركز تلقائيا الحقل على جبل"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"التركيز التلقائي"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"الحد الأقصى لعدد الصفوف المرئية للإدخال متعدد الأسطر"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"ماكس الصفوف"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"يعرض منطقة نصية بدلا من إدخال سطر واحد"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"متعدد الأسطر"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"نوع إدخال هتمل (نص ، كلمة مرور ، بريد إلكتروني ، إلخ.)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"النوع"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"يعرض معلومات سياقية عند التمرير أو التركيز أو اللمس"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"تلميح الأدوات"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"يعرض سهم يشير إلى العنصر الهدف"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"السهم"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"يمنع تلميح الأدوات من الظهور عند التركيز"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"تعطيل مستمع التركيز"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"يمنع تلميح الأدوات من الظهور عند التمرير"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"تعطيل تحوم المستمع"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"تعطيل التفاعل مع محتوى تلميح الأدوات"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"تعطيل التفاعلية"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"يمنع تلميح الأدوات من الظهور عند اللمس"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"تعطيل مستمع اللمس"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"تأخير بالمللي ثانية قبل إظهار تلميح الأداة"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"أدخل تأخير"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"يجعل تلميح الأداة يتبع موضع المؤشر"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"اتبع المؤشر"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"تأخير بالمللي ثانية قبل إخفاء تلميح الأداة"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"تأخير الإجازة"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"محتوى النص المعروض داخل تلميح الأداة"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"العنوان"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"يعرض النص مع أنماط الطباعة المحددة مسبقا"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"الطباعة"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"محتوى النص"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"المحتوى"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"مكون لتحميل ملف واحد أو أكثر"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"رافع"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"أنواع الملفات المسموح بها (على سبيل المثال \".جي بي جي,.بابوا نيو غينيا\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"قبول"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"يسمح بتحديد ملفات متعددة"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"متعددة"`


---

# Variable: muiBox

> `const` **muiBox**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`Omit`<[`MuiBoxProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBoxProps), `"ref"`> & `RefAttributes`<`unknown`>>


---

# Variable: muiBreadcrumbs

> `const` **muiBreadcrumbs**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiBreadcrumbsProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiBreadcrumbsProps)>


---

# Variable: muiButton

> `const` **muiButton**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`ButtonProps`>


---

# Variable: muiButtonGroup

> `const` **muiButtonGroup**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`DefaultComponentProps`<`ButtonGroupTypeMap`<{ }, `"div"`>>>


---

# Variable: muiCard

> `const` **muiCard**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiCardProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiCardProps)>


---

# Variable: muiCheckbox

> `const` **muiCheckbox**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiCheckboxProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiCheckboxProps)>

Material UI Checkbox component definition for the form builder.


---

# Variable: muiCircularProgress

> `const` **muiCircularProgress**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`CircularProgressProps`>


---

# Variable: muiComponents

> `const` **muiComponents**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`any`>\[]

An array of Material UI component metadata factories.


---

# Variable: muiContainer

> `const` **muiContainer**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`Omit`<[`MuiContainerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiContainerProps), `"ref"`> & `RefAttributes`<`HTMLDivElement`>>


---

# Variable: muiDeDeComponentsDescriptions

> **muiDeDeComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"Datenanzeige"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"Feedback"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"Form"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"Eingang"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"Layout"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"Navigation"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"Chen"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"Wenn true, wird die Komponente überprüft"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"Ft"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"Der Inhalt der Komponente"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"Kinder"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"Die Farbe der Komponente"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"Farbig"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"Standardwert. Verwenden Sie, wenn die Komponente nicht gesteuert wird"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"Standardwert"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"Wenn wahr, reduziert die vertikale Auffüllung"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"Dicht"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"Wenn true, ist die Komponente deaktiviert"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"Behinderte"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"Wenn true, deaktiviert die linke und rechte Auffüllung"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"Dachrinnen deaktivieren"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"Wenn true, deaktiviert die Standardauffüllung"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"Padding deaktivieren"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"Wenn true, wird die Komponente in einem Fehlerzustand angezeigt"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"Fehlermeldung"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"Wenn true, nimmt die Komponente die volle Breite ihres Containers ein"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"Volle Breite"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"Wenn wahr, hat der Text einen unteren Rand"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"Dachrinnenboden"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"Der Hilfstextinhalt"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"Hilfstext"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"Definiert den Rand, der auf die Komponente angewendet wird"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"Marge"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"Wenn true, wird der Text nicht umgebrochen, sondern stattdessen mit einer Textüberlauf-Ellipse abgeschnitten"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"Keine Verpackung"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"Callback wird ausgelöst, wenn der Wert geändert wird"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"Bei Änderung"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"Callback wird ausgelöst, wenn auf die Komponente geklickt wird"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"onClick"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"Wenn true, ist das Eingabeelement erforderlich"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"Erforderlich"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"Die Größe der Komponente"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"Größe"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"Die Systemrequisite, mit der Systemüberschreibungen sowie zusätzliche CSS-Stile definiert werden können"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"Textausrichtung"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"Ausrichtung"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"Der Wert der Komponente"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"Wert"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"Die zu verwendende Variante"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"Variante"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"Generischer Layout-Container mit Unterstützung für Systemstile"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"Box"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"Zeigt die aktuelle Seitenposition innerhalb einer Hierarchie an"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"Brotkrumen"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"Anzuzeigende Breadcrumb-Elemente"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"Gegenst"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"Wenn die maximale Anzahl von Elementen überschritten wird, die Anzahl der Elemente, die nach den Auslassungspunkten angezeigt werden sollen"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"Elemente nach dem Zusammenbruch"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"Wenn die maximale Anzahl von Elementen überschritten wird, die Anzahl der Elemente, die vor den Auslassungspunkten angezeigt werden sollen"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"Elemente vor dem Zusammenbruch"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"Gibt die maximale Anzahl der anzuzeigenden Brotkrumen an"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"Maximale Artikel"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"Element zum Trennen von Breadcrumb-Elementen"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"Trennzeichen"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"Eine Schaltflächenkomponente, die zum Auslösen von Aktionen oder Ereignissen verwendet wird"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"Schaltfläche"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"Beschriftung"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"Inhalt"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"Entfernt den Schaltflächenschatten, wenn er auf true gesetzt ist"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"Erhöhung deaktivieren"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"Zeigt eine Ladeanzeige an und deaktiviert die Interaktion"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"Laden"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"Gruppiert verwandte Schaltflächen zusammen"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"Tastengruppe"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"Lässt die Schaltflächengruppe die gesamte Containerbreite überspannen"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"Volle Breite"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"Legt die Layoutrichtung der Schaltflächen fest"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"Orientierung"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"Oberflächenkomponente zum Gruppieren verwandter Inhalte"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"Karte"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"Aktionsschaltflächen oder Steuerelemente für die Karte"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"Aktionen"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"Im Kartenkopf gerenderter Inhalt"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"Header"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"In der Kopfzeile angezeigtes Aktionselement"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"Header-Aktion"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"Avatar-Element, das in der Kopfzeile angezeigt wird"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"Kopfzeile Avatar"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"Medieninhalte wie ein Bild oder Video"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"Medium"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"Callback wird ausgelöst, wenn die Karte ausgewählt ist"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"Bei Auswahl"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"Sekundärer Text, der unter der Kopfzeile angezeigt wird"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"Unterkopfzeile"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"Zeigt unten einen Aktionsabschnitt an"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"Aktionen verwenden"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"Umschließt Inhalte mit einem anklickbaren Aktionsbereich"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"Kartenaktionsbereich verwenden"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"Aktiviert den Kartenkopfbereich"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"Kopfzeile verwenden"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"Aktiviert einen Aktionsbereich innerhalb der Kopfzeile"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"Header-Aktion verwenden"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"Zeigt einen Avatar in der Kopfzeile an"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"Kopfzeilen-Avatar verwenden"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"Aktiviert einen Medienbereich innerhalb der Karte"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"Medien verwenden"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"Zeigt eine Unterüberschrift unter der Hauptüberschrift an"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"Unterüberschrift verwenden"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"Ermöglicht die Auswahl einer oder mehrerer Optionen"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"Kontrollkästchen"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"Initial geprüfter Zustand bei unkontrolliertem"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"Standardmäßig aktiviert"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"Zeigt das Laden oder den Fortschritt in Kreisform an"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"Zirkulärer Fortschritt"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"Deaktiviert die Verkleinerungsanimation"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"Verkleinern deaktivieren"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"Steuert die Strichbreite des Kreises"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"Stärke"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"Zentriert und beschränkt Inhalte horizontal"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"Container"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"Legt eine feste maximale Breite anstelle einer fließenden fest"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"Fest"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"Definiert die maximale Breite des Containers"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"Maximale Breite"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"Umschließt Inhalte und zeigt einen Fehlerstatus oder eine Fehlermeldung an"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"Fehler-Wrapper"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"Verknüpft eine Beschriftung mit einem Formularsteuerelement"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"Formular-Kontrolletikett"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"Formular-Bedienelement (Checkbox, Radio, Schalter)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"Kontrolle"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"Position des Etiketts relativ zum Steuerelement"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"Etikettenplatzierung"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"Beschriftung zum Gruppieren oder Beschreiben von Formularfeldern"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"Formularetikett"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"Wendet das Styling des gefüllten Zustands an"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"Gef"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"Zeigt das Laden oder den Fortschritt in einem linearen Balken an"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"Linearer Fortschritt"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"Sekundärer Pufferwert für gepufferten Fortschrittsmodus"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"Wertepuffer"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"Anklickbares Element für Navigation oder Aktionen"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"Verknüpfen"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"Ziel-URL"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Href"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"Zeigt eine vertikale Liste von Elementen an"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"Liste"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"Repräsentiert ein einzelnes Element in einer Liste"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"Listenelemente"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"Zeigt eine Trennlinie unter dem Listenelement an"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"Teiler"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"Ermöglicht die Auswahl einer einzelnen Option aus einem Satz"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"Radiogruppe"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"Namensattribut zum Gruppieren von Optionsfeldern"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"Name"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"Optionsfelder horizontal anzeigen"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"Zeile"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"Ein einzelnes Optionsfeld, das innerhalb einer Funkgruppe verwendet wird"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"Funkgerät"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"Dropdown-Komponente zur Auswahl von Optionen"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"Wählen"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"Fokussiert das Feld automatisch auf die Halterung"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"Autofokus"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"Ermöglicht die Auswahl mehrerer Optionen"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"Mehrere"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"Layouts von untergeordneten Elementen in einem eindimensionalen Stapel"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"Stack"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"Steuert die achsenübergreifende Ausrichtung"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"Elemente ausrichten"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"Definiert, ob Elemente in einer Zeile oder Spalte gestapelt werden"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"Richtung"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"Steuert, ob Elemente in mehrere Zeilen umgebrochen werden"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"Flexwickel"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"Steuert die Ausrichtung der Hauptachse"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"Inhalt begründen"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"Abstand zwischen gestapelten Gegenständen"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"Zeilenabstand"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"Verwendet CSS-Lücke anstelle von Rändern für Abstände"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"Flex Gap verwenden"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"Kippschalter zum Umschalten zwischen zwei Zuständen"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"Schalter"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"Anfänglicher Kippzustand bei unkontrolliertem"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"Standardmäßig aktiviert"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"Eingabefeld für Text- und Formulardaten"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"Textfeld"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"Fokussiert das Feld automatisch auf die Halterung"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"Autofokus"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"Maximale Anzahl sichtbarer Zeilen für mehrzeilige Eingabe"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"Maximale Reihen"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"Rendert einen Textbereich anstelle einer einzeiligen Eingabe"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"Mehrzeilige"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"HTML-Eingabetyp (Text, Passwort, E-Mail usw.).)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"Art"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"Zeigt Kontextinformationen beim Schweben, Fokussieren oder Berühren an"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"QuickInfo"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"Zeigt einen Pfeil an, der auf das Zielelement zeigt"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"Pfeil"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"Verhindert, dass der Tooltip im Fokus angezeigt wird"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"Fokus-Listener deaktivieren"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"Verhindert, dass der Tooltip beim Schweben angezeigt wird"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"Hover-Listener deaktivieren"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"Deaktiviert die Interaktion mit dem Tooltip-Inhalt"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"Interaktiv deaktivieren"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"Verhindert, dass der Tooltip bei Berührung angezeigt wird"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"Touch-Listener deaktivieren"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"Verzögerung in Millisekunden, bevor der Tooltip angezeigt wird"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"Verzögerung eingeben"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"Lässt den Tooltip der Cursorposition folgen"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"Cursor folgen"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"Verzögerung in Millisekunden vor dem Ausblenden des Tooltips"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"Verspätung verlassen"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"Textinhalt, der in der Quickinfo angezeigt wird"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"Titelleiste"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"Zeigt Text mit vordefinierten Typografiestilen an"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"Typografie"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"Textinhalt"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"Inhalt"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"Komponente zum Hochladen einer oder mehrerer Dateien"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"Uploader"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"Erlaubte Dateitypen (z.B. \".jpeg,.png\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"Akzeptieren"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"Ermöglicht die Auswahl mehrerer Dateien"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"Mehrere"`


---

# Variable: muiDialog

> `const` **muiDialog**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiDialogProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiDialogProps)>


---

# Variable: muiDialogActions

> `const` **muiDialogActions**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`DialogActionsProps`>


---

# Variable: muiDialogContent

> `const` **muiDialogContent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`DialogContentProps`>


---

# Variable: muiDialogContentText

> `const` **muiDialogContentText**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`DefaultComponentProps`<`DialogContentTextTypeMap`<{ }, `"span"`>>>


---

# Variable: muiDialogLayout

> `const` **muiDialogLayout**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`object`>


---

# Variable: muiDialogTitle

> `const` **muiDialogTitle**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`DefaultComponentProps`<`DialogTitleTypeMap`<{ }, `"span"`>>>


---

# Variable: muiEnUsComponentsDescriptions

> **muiEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"Data display"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"Feedback"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"Form"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"Inputs"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"Layout"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"Navigation"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"Surfaces"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"If true, the component is checked"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"Checked"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"The content of the component"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"Children"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"The color of the component"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"Color"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"The default value. Use when the component is not controlled"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"Default value"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"If true, reduces vertical padding"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"Dense"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"If true, the component is disabled"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"Disabled"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"If true, disables the left and right padding"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"Disable gutters"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"If true, disables the default padding"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"Disable padding"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"If true, the component is displayed in an error state"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"Error"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"If true, the component takes up the full width of its container"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"Full width"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"If true, the text will have a bottom margin"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"Gutter bottom"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"The helper text content"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"Helper text"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"Defines the margin applied to the component"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"Margin"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"If true, the text will not wrap, but instead will truncate with a text overflow ellipsis"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"No wrap"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"Callback fired when the value is changed"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"onChange"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"Callback fired when the component is clicked"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"onClick"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"If true, the input element is required"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"Required"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"The size of the component"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"Size"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"The system prop that allows defining system overrides as well as additional CSS styles"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"Text alignment"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"Alignment"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"The value of the component"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"Value"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"The variant to use"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"Variant"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"Generic layout container with system styling support"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"Box"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"Shows the current page location within a hierarchy"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"Breadcrumbs"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"Breadcrumb items to display"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"Items"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"If max items is exceeded, the number of items to show after the ellipsis"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"Items after collapse"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"If max items is exceeded, the number of items to show before the ellipsis"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"Items before collapse"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"Specifies the maximum number of breadcrumbs to display"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"Max items"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"Element used to separate breadcrumb items"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"Separator"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"A button component used to trigger actions or events"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"Button"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"The caption"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"Content"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"Removes the button shadow when set to true"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"Disable elevation"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"Displays a loading indicator and disables interaction"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"Loading"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"Groups related buttons together"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"Button group"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"Makes the button group span the full container width"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"Full width"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"Sets the layout direction of the buttons"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"Orientation"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"Surface component for grouping related content"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"Card"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"Action buttons or controls for the card"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"Actions"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"Content rendered in the card header"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"Header"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"Action element displayed in the header"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"Header action"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"Avatar element displayed in the header"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"Header avatar"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"Media content such as an image or video"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"Media"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"Callback triggered when the card is selected"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"onSelect"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"Secondary text displayed below the header"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"Sub header"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"Displays an actions section at the bottom"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"Use actions"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"Wraps content with a clickable action area"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"Use card action area"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"Enables the card header section"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"Use header"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"Enables an action area inside the header"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"Use header action"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"Displays an avatar inside the header"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"Use header avatar"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"Enables a media section inside the card"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"Use media"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"Displays a subheader below the main header"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"Use subheader"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"Allows selecting one or more options"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"Checkbox"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"Initial checked state when uncontrolled"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"Default checked"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"Indicates loading or progress in a circular form"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"Circular progress"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"Disables the shrink animation"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"Disable shrink"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"Controls the stroke width of the circle"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"Thickness"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"Centers and constrains content horizontally"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"Container"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"Sets a fixed max width instead of a fluid one"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"Fixed"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"Defines the maximum width of the container"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"Max width"`

#### components.MuiDialog[​](#componentsmuidialog "Direct link to components.MuiDialog")

> **components.MuiDialog**: `object`

#### components.MuiDialog.description[​](#componentsmuidialogdescription "Direct link to components.MuiDialog.description")

> **components.MuiDialog.description**: `string` = `"A modal dialog component that displays content in an overlay"`

#### components.MuiDialog.name[​](#componentsmuidialogname "Direct link to components.MuiDialog.name")

> **components.MuiDialog.name**: `string` = `"Dialog"`

#### components.MuiDialog.props[​](#componentsmuidialogprops "Direct link to components.MuiDialog.props")

> **components.MuiDialog.props**: `object`

#### components.MuiDialog.props.disableEscapeKeyDown[​](#componentsmuidialogpropsdisableescapekeydown "Direct link to components.MuiDialog.props.disableEscapeKeyDown")

> **components.MuiDialog.props.disableEscapeKeyDown**: `object`

#### components.MuiDialog.props.disableEscapeKeyDown.description[​](#componentsmuidialogpropsdisableescapekeydowndescription "Direct link to components.MuiDialog.props.disableEscapeKeyDown.description")

> **components.MuiDialog.props.disableEscapeKeyDown.description**: `string` = `"If true, pressing the escape key will not close the dialog"`

#### components.MuiDialog.props.disableEscapeKeyDown.name[​](#componentsmuidialogpropsdisableescapekeydownname "Direct link to components.MuiDialog.props.disableEscapeKeyDown.name")

> **components.MuiDialog.props.disableEscapeKeyDown.name**: `string` = `"Disable escape key down"`

#### components.MuiDialog.props.fullScreen[​](#componentsmuidialogpropsfullscreen "Direct link to components.MuiDialog.props.fullScreen")

> **components.MuiDialog.props.fullScreen**: `object`

#### components.MuiDialog.props.fullScreen.description[​](#componentsmuidialogpropsfullscreendescription "Direct link to components.MuiDialog.props.fullScreen.description")

> **components.MuiDialog.props.fullScreen.description**: `string` = `"If true, the dialog will be full screen"`

#### components.MuiDialog.props.fullScreen.name[​](#componentsmuidialogpropsfullscreenname "Direct link to components.MuiDialog.props.fullScreen.name")

> **components.MuiDialog.props.fullScreen.name**: `string` = `"Full screen"`

#### components.MuiDialog.props.fullWidth[​](#componentsmuidialogpropsfullwidth "Direct link to components.MuiDialog.props.fullWidth")

> **components.MuiDialog.props.fullWidth**: `object`

#### components.MuiDialog.props.fullWidth.description[​](#componentsmuidialogpropsfullwidthdescription "Direct link to components.MuiDialog.props.fullWidth.description")

> **components.MuiDialog.props.fullWidth.description**: `string` = `"If true, the dialog stretches to maxWidth"`

#### components.MuiDialog.props.fullWidth.name[​](#componentsmuidialogpropsfullwidthname "Direct link to components.MuiDialog.props.fullWidth.name")

> **components.MuiDialog.props.fullWidth.name**: `string` = `"Full width"`

#### components.MuiDialog.props.maxWidth[​](#componentsmuidialogpropsmaxwidth "Direct link to components.MuiDialog.props.maxWidth")

> **components.MuiDialog.props.maxWidth**: `object`

#### components.MuiDialog.props.maxWidth.description[​](#componentsmuidialogpropsmaxwidthdescription "Direct link to components.MuiDialog.props.maxWidth.description")

> **components.MuiDialog.props.maxWidth.description**: `string` = `"Maximum width of the dialog (xs, sm, md, lg, xl)"`

#### components.MuiDialog.props.maxWidth.name[​](#componentsmuidialogpropsmaxwidthname "Direct link to components.MuiDialog.props.maxWidth.name")

> **components.MuiDialog.props.maxWidth.name**: `string` = `"Max width"`

#### components.MuiDialog.props.onClose[​](#componentsmuidialogpropsonclose "Direct link to components.MuiDialog.props.onClose")

> **components.MuiDialog.props.onClose**: `object`

#### components.MuiDialog.props.onClose.description[​](#componentsmuidialogpropsonclosedescription "Direct link to components.MuiDialog.props.onClose.description")

> **components.MuiDialog.props.onClose.description**: `string` = `"Callback fired when the dialog is closing"`

#### components.MuiDialog.props.onClose.name[​](#componentsmuidialogpropsonclosename "Direct link to components.MuiDialog.props.onClose.name")

> **components.MuiDialog.props.onClose.name**: `string` = `"onClose"`

#### components.MuiDialog.props.open[​](#componentsmuidialogpropsopen "Direct link to components.MuiDialog.props.open")

> **components.MuiDialog.props.open**: `object`

#### components.MuiDialog.props.open.description[​](#componentsmuidialogpropsopendescription "Direct link to components.MuiDialog.props.open.description")

> **components.MuiDialog.props.open.description**: `string` = `"If true, the dialog is open"`

#### components.MuiDialog.props.open.name[​](#componentsmuidialogpropsopenname "Direct link to components.MuiDialog.props.open.name")

> **components.MuiDialog.props.open.name**: `string` = `"Open"`

#### components.MuiDialog.props.scroll[​](#componentsmuidialogpropsscroll "Direct link to components.MuiDialog.props.scroll")

> **components.MuiDialog.props.scroll**: `object`

#### components.MuiDialog.props.scroll.description[​](#componentsmuidialogpropsscrolldescription "Direct link to components.MuiDialog.props.scroll.description")

> **components.MuiDialog.props.scroll.description**: `string` = `"Determines the container for scrolling the dialog (paper or body)"`

#### components.MuiDialog.props.scroll.name[​](#componentsmuidialogpropsscrollname "Direct link to components.MuiDialog.props.scroll.name")

> **components.MuiDialog.props.scroll.name**: `string` = `"Scroll"`

#### components.MuiDialog.props.sx[​](#componentsmuidialogpropssx "Direct link to components.MuiDialog.props.sx")

> **components.MuiDialog.props.sx**: `object`

#### components.MuiDialog.props.sx.description[​](#componentsmuidialogpropssxdescription "Direct link to components.MuiDialog.props.sx.description")

> **components.MuiDialog.props.sx.description**: `string` = `"The system prop that allows defining system overrides as well as additional CSS styles"`

#### components.MuiDialog.props.sx.name[​](#componentsmuidialogpropssxname "Direct link to components.MuiDialog.props.sx.name")

> **components.MuiDialog.props.sx.name**: `string` = `"Sx"`

#### components.MuiDialogActions[​](#componentsmuidialogactions "Direct link to components.MuiDialogActions")

> **components.MuiDialogActions**: `object`

#### components.MuiDialogActions.description[​](#componentsmuidialogactionsdescription "Direct link to components.MuiDialogActions.description")

> **components.MuiDialogActions.description**: `string` = `"Container for dialog action buttons"`

#### components.MuiDialogActions.name[​](#componentsmuidialogactionsname "Direct link to components.MuiDialogActions.name")

> **components.MuiDialogActions.name**: `string` = `"Dialog actions"`

#### components.MuiDialogActions.props[​](#componentsmuidialogactionsprops "Direct link to components.MuiDialogActions.props")

> **components.MuiDialogActions.props**: `object`

#### components.MuiDialogActions.props.children[​](#componentsmuidialogactionspropschildren "Direct link to components.MuiDialogActions.props.children")

> **components.MuiDialogActions.props.children**: `object`

#### components.MuiDialogActions.props.children.description[​](#componentsmuidialogactionspropschildrendescription "Direct link to components.MuiDialogActions.props.children.description")

> **components.MuiDialogActions.props.children.description**: `string` = `"The content of the component"`

#### components.MuiDialogActions.props.children.name[​](#componentsmuidialogactionspropschildrenname "Direct link to components.MuiDialogActions.props.children.name")

> **components.MuiDialogActions.props.children.name**: `string` = `"Children"`

#### components.MuiDialogActions.props.disableSpacing[​](#componentsmuidialogactionspropsdisablespacing "Direct link to components.MuiDialogActions.props.disableSpacing")

> **components.MuiDialogActions.props.disableSpacing**: `object`

#### components.MuiDialogActions.props.disableSpacing.description[​](#componentsmuidialogactionspropsdisablespacingdescription "Direct link to components.MuiDialogActions.props.disableSpacing.description")

> **components.MuiDialogActions.props.disableSpacing.description**: `string` = `"If true, the actions do not have additional margin"`

#### components.MuiDialogActions.props.disableSpacing.name[​](#componentsmuidialogactionspropsdisablespacingname "Direct link to components.MuiDialogActions.props.disableSpacing.name")

> **components.MuiDialogActions.props.disableSpacing.name**: `string` = `"Disable spacing"`

#### components.MuiDialogActions.props.sx[​](#componentsmuidialogactionspropssx "Direct link to components.MuiDialogActions.props.sx")

> **components.MuiDialogActions.props.sx**: `object`

#### components.MuiDialogActions.props.sx.description[​](#componentsmuidialogactionspropssxdescription "Direct link to components.MuiDialogActions.props.sx.description")

> **components.MuiDialogActions.props.sx.description**: `string` = `"The system prop that allows defining system overrides as well as additional CSS styles"`

#### components.MuiDialogActions.props.sx.name[​](#componentsmuidialogactionspropssxname "Direct link to components.MuiDialogActions.props.sx.name")

> **components.MuiDialogActions.props.sx.name**: `string` = `"Sx"`

#### components.MuiDialogContent[​](#componentsmuidialogcontent "Direct link to components.MuiDialogContent")

> **components.MuiDialogContent**: `object`

#### components.MuiDialogContent.description[​](#componentsmuidialogcontentdescription "Direct link to components.MuiDialogContent.description")

> **components.MuiDialogContent.description**: `string` = `"Main content area of a dialog"`

#### components.MuiDialogContent.name[​](#componentsmuidialogcontentname "Direct link to components.MuiDialogContent.name")

> **components.MuiDialogContent.name**: `string` = `"Dialog content"`

#### components.MuiDialogContent.props[​](#componentsmuidialogcontentprops "Direct link to components.MuiDialogContent.props")

> **components.MuiDialogContent.props**: `object`

#### components.MuiDialogContent.props.children[​](#componentsmuidialogcontentpropschildren "Direct link to components.MuiDialogContent.props.children")

> **components.MuiDialogContent.props.children**: `object`

#### components.MuiDialogContent.props.children.description[​](#componentsmuidialogcontentpropschildrendescription "Direct link to components.MuiDialogContent.props.children.description")

> **components.MuiDialogContent.props.children.description**: `string` = `"The content of the component"`

#### components.MuiDialogContent.props.children.name[​](#componentsmuidialogcontentpropschildrenname "Direct link to components.MuiDialogContent.props.children.name")

> **components.MuiDialogContent.props.children.name**: `string` = `"Children"`

#### components.MuiDialogContent.props.dividers[​](#componentsmuidialogcontentpropsdividers "Direct link to components.MuiDialogContent.props.dividers")

> **components.MuiDialogContent.props.dividers**: `object`

#### components.MuiDialogContent.props.dividers.description[​](#componentsmuidialogcontentpropsdividersdescription "Direct link to components.MuiDialogContent.props.dividers.description")

> **components.MuiDialogContent.props.dividers.description**: `string` = `"If true, borders are added to the top and bottom of the dialog content"`

#### components.MuiDialogContent.props.dividers.name[​](#componentsmuidialogcontentpropsdividersname "Direct link to components.MuiDialogContent.props.dividers.name")

> **components.MuiDialogContent.props.dividers.name**: `string` = `"Dividers"`

#### components.MuiDialogContent.props.sx[​](#componentsmuidialogcontentpropssx "Direct link to components.MuiDialogContent.props.sx")

> **components.MuiDialogContent.props.sx**: `object`

#### components.MuiDialogContent.props.sx.description[​](#componentsmuidialogcontentpropssxdescription "Direct link to components.MuiDialogContent.props.sx.description")

> **components.MuiDialogContent.props.sx.description**: `string` = `"The system prop that allows defining system overrides as well as additional CSS styles"`

#### components.MuiDialogContent.props.sx.name[​](#componentsmuidialogcontentpropssxname "Direct link to components.MuiDialogContent.props.sx.name")

> **components.MuiDialogContent.props.sx.name**: `string` = `"Sx"`

#### components.MuiDialogContentText[​](#componentsmuidialogcontenttext "Direct link to components.MuiDialogContentText")

> **components.MuiDialogContentText**: `object`

#### components.MuiDialogContentText.description[​](#componentsmuidialogcontenttextdescription "Direct link to components.MuiDialogContentText.description")

> **components.MuiDialogContentText.description**: `string` = `"Text content inside a dialog"`

#### components.MuiDialogContentText.name[​](#componentsmuidialogcontenttextname "Direct link to components.MuiDialogContentText.name")

> **components.MuiDialogContentText.name**: `string` = `"Dialog content text"`

#### components.MuiDialogContentText.props[​](#componentsmuidialogcontenttextprops "Direct link to components.MuiDialogContentText.props")

> **components.MuiDialogContentText.props**: `object`

#### components.MuiDialogContentText.props.children[​](#componentsmuidialogcontenttextpropschildren "Direct link to components.MuiDialogContentText.props.children")

> **components.MuiDialogContentText.props.children**: `object`

#### components.MuiDialogContentText.props.children.description[​](#componentsmuidialogcontenttextpropschildrendescription "Direct link to components.MuiDialogContentText.props.children.description")

> **components.MuiDialogContentText.props.children.description**: `string` = `"The text content"`

#### components.MuiDialogContentText.props.children.name[​](#componentsmuidialogcontenttextpropschildrenname "Direct link to components.MuiDialogContentText.props.children.name")

> **components.MuiDialogContentText.props.children.name**: `string` = `"Content"`

#### components.MuiDialogContentText.props.sx[​](#componentsmuidialogcontenttextpropssx "Direct link to components.MuiDialogContentText.props.sx")

> **components.MuiDialogContentText.props.sx**: `object`

#### components.MuiDialogContentText.props.sx.description[​](#componentsmuidialogcontenttextpropssxdescription "Direct link to components.MuiDialogContentText.props.sx.description")

> **components.MuiDialogContentText.props.sx.description**: `string` = `"The system prop that allows defining system overrides as well as additional CSS styles"`

#### components.MuiDialogContentText.props.sx.name[​](#componentsmuidialogcontenttextpropssxname "Direct link to components.MuiDialogContentText.props.sx.name")

> **components.MuiDialogContentText.props.sx.name**: `string` = `"Sx"`

#### components.MuiDialogLayout[​](#componentsmuidialoglayout "Direct link to components.MuiDialogLayout")

> **components.MuiDialogLayout**: `object`

#### components.MuiDialogLayout.description[​](#componentsmuidialoglayoutdescription "Direct link to components.MuiDialogLayout.description")

> **components.MuiDialogLayout.description**: `string` = `"A preset dialog layout with title, content, and action buttons"`

#### components.MuiDialogLayout.name[​](#componentsmuidialoglayoutname "Direct link to components.MuiDialogLayout.name")

> **components.MuiDialogLayout.name**: `string` = `"Dialog layout"`

#### components.MuiDialogTitle[​](#componentsmuidialogtitle "Direct link to components.MuiDialogTitle")

> **components.MuiDialogTitle**: `object`

#### components.MuiDialogTitle.description[​](#componentsmuidialogtitledescription "Direct link to components.MuiDialogTitle.description")

> **components.MuiDialogTitle.description**: `string` = `"Title of a dialog"`

#### components.MuiDialogTitle.name[​](#componentsmuidialogtitlename "Direct link to components.MuiDialogTitle.name")

> **components.MuiDialogTitle.name**: `string` = `"Dialog title"`

#### components.MuiDialogTitle.props[​](#componentsmuidialogtitleprops "Direct link to components.MuiDialogTitle.props")

> **components.MuiDialogTitle.props**: `object`

#### components.MuiDialogTitle.props.children[​](#componentsmuidialogtitlepropschildren "Direct link to components.MuiDialogTitle.props.children")

> **components.MuiDialogTitle.props.children**: `object`

#### components.MuiDialogTitle.props.children.description[​](#componentsmuidialogtitlepropschildrendescription "Direct link to components.MuiDialogTitle.props.children.description")

> **components.MuiDialogTitle.props.children.description**: `string` = `"The title text"`

#### components.MuiDialogTitle.props.children.name[​](#componentsmuidialogtitlepropschildrenname "Direct link to components.MuiDialogTitle.props.children.name")

> **components.MuiDialogTitle.props.children.name**: `string` = `"Content"`

#### components.MuiDialogTitle.props.sx[​](#componentsmuidialogtitlepropssx "Direct link to components.MuiDialogTitle.props.sx")

> **components.MuiDialogTitle.props.sx**: `object`

#### components.MuiDialogTitle.props.sx.description[​](#componentsmuidialogtitlepropssxdescription "Direct link to components.MuiDialogTitle.props.sx.description")

> **components.MuiDialogTitle.props.sx.description**: `string` = `"The system prop that allows defining system overrides as well as additional CSS styles"`

#### components.MuiDialogTitle.props.sx.name[​](#componentsmuidialogtitlepropssxname "Direct link to components.MuiDialogTitle.props.sx.name")

> **components.MuiDialogTitle.props.sx.name**: `string` = `"Sx"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"Wraps content and displays an error state or message"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"Error wrapper"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"Associates a label with a form control"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"Form control label"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"Form control element (checkbox, radio, switch)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"Control"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"Position of the label relative to the control"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"Label placement"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"Label for grouping or describing form fields"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"Form label"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"Applies the filled state styling"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"Filled"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"Indicates loading or progress in a linear bar"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"Linear progress"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"Secondary buffer value for buffered progress mode"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"Value buffer"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"Clickable element for navigation or actions"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"Link"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"Destination URL"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Href"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"Displays a vertical list of items"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"List"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"Represents a single item inside a list"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"List item"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"Displays a divider below the list item"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"Divider"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"Allows selecting a single option from a set"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"Radio group"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"Name attribute used to group radio buttons"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"Name"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"Displays radio buttons horizontally"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"Row"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"A single radio button used within a radio group"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"Radio item"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"Dropdown component for selecting options"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"Select"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"Automatically focuses the field on mount"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"Auto focus"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"Allows selecting multiple options"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"Multiple"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"Layouts children in a one-dimensional stack"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"Stack"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"Controls cross-axis alignment"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"Align items"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"Defines whether items are stacked in a row or column"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"Direction"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"Controls whether items wrap onto multiple lines"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"Flex wrap"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"Controls main-axis alignment"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"Justify content"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"Spacing between stacked items"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"Spacing"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"Uses CSS gap instead of margins for spacing"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"Use flex gap"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"Toggle control for switching between two states"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"Switch"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"Initial toggle state when uncontrolled"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"Default checked"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"Input field for text and form data"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"Text field"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"Automatically focuses the field on mount"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"Auto focus"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"Maximum number of visible rows for multiline input"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"Max rows"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"Renders a textarea instead of a single-line input"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"Multiline"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"HTML input type (text, password, email, etc.)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"Type"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"Displays contextual information on hover, focus, or touch"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"Tooltip"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"Displays an arrow pointing to the target element"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"Arrow"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"Prevents the tooltip from appearing on focus"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"Disable focus listener"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"Prevents the tooltip from appearing on hover"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"Disable hover listener"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"Disables interaction with the tooltip content"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"Disable interactive"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"Prevents the tooltip from appearing on touch"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"Disable touch listener"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"Delay in milliseconds before showing the tooltip"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"Enter delay"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"Makes the tooltip follow the cursor position"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"Follow cursor"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"Delay in milliseconds before hiding the tooltip"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"Leave delay"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"Text content displayed inside the tooltip"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"Title"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"Displays text with predefined typography styles"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"Typography"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"The text content"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"Content"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"Component for uploading one or more files"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"Uploader"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"Allowed file types (e.g. \".jpg,.png\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"Accept"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"Allows selecting multiple files"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"Multiple"`


---

# Variable: muiErrorWrapper

> `const` **muiErrorWrapper**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)>


---

# Variable: muiEsEsComponentsDescriptions

> **muiEsEsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"Visualización de datos"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"Comentarios"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"Formulario"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"Entradas"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"Maquetación"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"Navegación"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"Superficies"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"Si es true, el componente está marcada"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"Comprobado"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"El contenido del componente"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"Niños"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"El color de la componente"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"Color"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"El valor predeterminado. Utilizar cuando el componente no está controlado"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"Valor predeterminado"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"Si es true, reduce el relleno vertical"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"Denso"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"Si es true, el componente está desactivado"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"Discapacitados"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"Si es true, se desactiva la izquierda y a la derecha de relleno"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"Deshabilitar canaletas"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"Si es true, se desactiva el relleno predeterminado"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"Desactivar el relleno"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"Si es true, el componente se muestra en un estado de error"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"Error"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"Si es true, el componente ocupa todo el ancho de su contenedor"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"Ancho completo"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"Si es true, el texto tendrá un margen inferior"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"Canaleta inferior"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"El ayudante de contenido de texto"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"Ayudante de texto"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"Define el margen aplicado al componente"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"Margen"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"Si es true, el texto no se ajustará, sino que se truncará con puntos suspensivos de desbordamiento de texto"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"No envuelva"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"De devolución de llamada se activa cuando se cambia el valor"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"onChange"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"De devolución de llamada se activa cuando el componente se hace clic en"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"onClick"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"Si es true, el elemento de entrada es necesario"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"Requerido"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"El tamaño de la componente"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"Tamaño"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"El sistema de la proposición, que permite definir el sistema de reemplazos, así como en otros estilos CSS"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"Alineación de texto"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"Alineación"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"El valor de la componente"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"Valor"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"La variante para el uso"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"Variante"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"Diseño genérico contenedor con sistema de compatibilidad de estilo"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"Caja"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"Muestra la ubicación actual de la página dentro de una jerarquía"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"Migas de Pan"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"Ruta de elementos para mostrar"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"Artículos"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"Si max elementos es excedido, el número de elementos a mostrar después de los puntos suspensivos"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"Elementos después del colapso"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"Si max elementos es excedido, el número de elementos a mostrar antes de los puntos suspensivos"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"Los elementos antes de colapso"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"Especifica el número máximo de pan rallado para mostrar"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"Max elementos"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"Elemento que se utiliza para separar elementos de la ruta de exploración"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"Separador de"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"Un componente de botón se utiliza para activar acciones o eventos"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"Botón"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"La leyenda"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"Contenido"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"Quita el botón de la sombra cuando se establece en true"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"Deshabilitar la elevación"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"Muestra un indicador de carga y desactiva la interacción"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"Cargando"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"Los grupos relacionados con los botones de"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"Grupo de botones de"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"Hace que el botón de grupo abarcan el contenedor lleno de ancho"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"Ancho completo"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"Establece la dirección de diseño de los botones"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"Orientación"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"Componente de la superficie de la agrupación de contenidos relacionados con la"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"Tarjeta"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"Los botones de acción o controles para la tarjeta"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"Acciones"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"El contenido representado en la tarjeta de encabezado"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"Cabecera"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"Elemento de acción se muestran en el encabezado"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"Encabezado de acción"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"Elemento Avatar que se muestra en el encabezado"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"Encabezado de avatar"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"Contenido de los medios como una imagen o video"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"Medios de Comunicación"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"De devolución de llamada se activa cuando la tarjeta está activada"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"onSelect"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"Secundaria de texto que aparece debajo de la cabecera"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"Sub encabezado"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"Muestra una sección de acciones en la parte inferior"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"Acciones de uso"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"Envuelve el contenido con un clickable área de acción"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"Uso de la tarjeta de acción de la zona"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"Permite que la tarjeta de encabezado de sección"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"El uso de encabezado"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"Habilita un área de acción dentro del encabezado"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"El uso de encabezado de acción"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"Muestra un avatar dentro del encabezado"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"El uso de encabezado de avatar"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"Permite que una sección de medios de comunicación en el interior de la tarjeta"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"El uso de los medios de comunicación"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"Muestra un subtítulo debajo del encabezado principal"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"Uso subheader"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"Permite seleccionar una o más opciones"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"Casilla de verificación"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"Inicial estado marcado cuando incontrolada"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"Por defecto activada"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"Indica la carga o el progreso en una forma circular"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"Circular progreso"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"Desactiva la animación de reducción"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"Deshabilitar la reducción"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"Controla el ancho del trazo del círculo"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"Espesor"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"Centros y se restringe el contenido horizontalmente"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"Contenedor"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"Establece un ancho máximo fijo en lugar de uno fluido"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"Fijo"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"Define el ancho máximo del contenedor"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"Anchura máxima"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"Envuelve el contenido y muestra un estado de error o mensaje"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"Contenedor de errores"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"Asocia una etiqueta con un control de formulario"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"Etiqueta de control de formulario"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"Elemento de control de formulario (casilla de verificación, radio, interruptor) "`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"Control"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"Posición de la etiqueta en relación al control de"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"La colocación de la etiqueta"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"Etiquetas para agrupar o descripción de los campos del formulario"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"Etiqueta de formulario"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"Se aplica el estado lleno de estilo"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"Llena"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"Indica la carga o el progreso en una barra lineal"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"El progreso lineal"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"Secundaria búfer de valor para el búfer de progreso en el modo"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"Valor de búfer"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"Puede hacer clic elemento para la navegación o acciones"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"Enlace"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"URL de destino"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Href"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"Muestra una lista vertical de los elementos"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"Lista"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"Representa un solo elemento dentro de una lista"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"Elemento de la lista"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"Muestra un divisor debajo del elemento de la lista"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"Divisor"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"Permite seleccionar una única opción de un conjunto de"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"Grupo de Radio"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"Atributo de nombre utilizado para agrupar botones de opción"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"Nombre"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"Muestra los botones de la radio horizontal"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"Fila"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"Un solo botón de radio se utilizan dentro de un radio de grupo"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"Radio punto"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"Componente desplegable para seleccionar opciones"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"Seleccione"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"Enfoca automáticamente el campo en el monte"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"Enfoque automático"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"Permite seleccionar varias opciones"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"Múltiple"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"Los diseños de los niños en la unidimensionalidad de la pila"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"Pila"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"Los controles de la cruz-alineación de los ejes"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"Alinear elementos"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"Define si los elementos se apilan en una fila o columna"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"Dirección"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"Controla si los elementos de envolver en varias líneas"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"Flex wrap"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"Los controles principales del eje de alineación"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"Justificar el contenido"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"El espaciado entre los objetos apilados"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"Espaciado"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"Usa espacio CSS en lugar de márgenes para el espaciado"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"El uso de flex brecha"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"Control basculante para la conmutación entre los dos estados"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"Interruptor"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"Primer cambio de estado cuando se descontrolada"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"Por defecto activada"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"Campo de entrada de texto y datos de formulario"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"Campo de texto"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"Enfoca automáticamente el campo en el monte"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"Enfoque automático"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"Número máximo de filas visibles para la entrada multilínea"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"Filas máximas"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"Representa un área de texto en lugar de una sola línea de entrada"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"Multilínea"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"HTML tipo de entrada (texto, contraseña, correo electrónico, etc.)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"Tipo"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"Muestra información contextual en hover, el enfoque, o toque"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"Descripción"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"Muestra una flecha que apunta al elemento de destino"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"Flecha"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"Evita que la información sobre herramientas que aparecen en el foco"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"Deshabilitar el enfoque de escucha"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"Evita que la información sobre herramientas aparezca al pasar el mouse"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"Deshabilitar pase oyente"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"Desactiva la interacción con la descripción del contenido"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"Deshabilitar interactivo"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"Evita que la información sobre herramientas aparece en contacto"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"Deshabilitar el toque de escucha"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"El retraso en milisegundos antes de mostrar el tooltip"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"Introduzca el retraso"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"Hace la descripción de seguir la posición del cursor"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"Siga el cursor"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"El retraso en milisegundos antes de ocultar la información sobre herramientas"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"Retraso en la licencia"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"El contenido de texto que se muestran dentro de la descripción"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"Título"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"Muestra el texto predefinidos estilos de tipografía"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"La tipografía"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"El contenido del texto"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"Contenido"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"Componente para subir uno o más archivos"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"Uploader"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"Tipos de archivo permitidos (por ejemplo,\".jpg,.png\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"Aceptar"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"Permite la selección de múltiples archivos"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"Múltiple"`


---

# Variable: muiFaIrComponentsDescriptions

> **muiFaIrComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"نمایش داده ها"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"بازخورد"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"فرم"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"ورودی ها"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"طرح بندی"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"ناوبری"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"سطوح"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"اگر درست باشد ، جزء بررسی می شود"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"چک شده"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"محتوای جزء"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"کودکان"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"رنگ جزء"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"رنگ"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"مقدار پیش فرض. استفاده از زمانی که جزء کنترل نشده است"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"مقدار پیش فرض"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"اگر درست باشد ، پودینگ عمودی را کاهش می دهد"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"متراکم"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"اگر درست باشد ، جزء غیرفعال است"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"معلول"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"اگر درست باشد ، پودینگ چپ و راست را غیرفعال می کند"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"ناودان ها را غیرفعال کنید"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"اگر درست باشد ، پودینگ پیش فرض را غیرفعال می کند"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"غیر فعال کردن padding"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"اگر درست باشد ، جزء در حالت خطا نمایش داده می شود"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"خطا"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"اگر درست باشد ، جزء عرض کامل ظرف خود را می گیرد"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"عرض کامل"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"اگر درست باشد ، متن حاشیه پایین خواهد داشت"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"پایین رودخانه"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"محتوای متن یاور"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"اس ام اس یار"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"حاشیه اعمال شده به جزء را تعریف می کند"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"حاشیه"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"اگر درست باشد ، متن بسته بندی نمی شود ، بلکه در عوض با یک بیضوی سرریز متن قطع می شود"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"بدون بسته بندی"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"وقتی مقدار تغییر کرد ، تماس برگشت اخراج شد"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"اونچنج"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"وقتی روی کامپوننت کلیک شد ، Callback شلیک شد"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"onClick"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"اگر درست باشد ، عنصر ورودی مورد نیاز است"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"مورد نیاز"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"اندازه قطعه"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"اندازه"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"پروپ سیستم که اجازه می دهد تا سیستم را تعریف کند و همچنین سبک های css اضافی را حذف کند"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"تراز متن"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"تراز بندی"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"ارزش جزء"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"ارزش"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"نوع مورد استفاده"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"نوع"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"ظرف طرح عمومی با پشتیبانی از یک ظاهر طراحی سیستم"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"جعبه"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"مکان صفحه فعلی را در یک سلسله مراتب نشان می دهد"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"آرد نان"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"وسایل نان خرد شده برای نمایش"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"آیتم ها"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"اگر حداکثر موارد بیش از حد باشد ، تعداد مواردی که باید پس از بیضوی نشان داده شود"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"اقلام پس از فروپاشی"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"اگر حداکثر موارد بیش از حد باشد ، تعداد مواردی که باید قبل از بیضوی نشان داده شود"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"اقلام قبل از سقوط"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"حداکثر تعداد نان خرد شده را برای نمایش مشخص می کند"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"حداکثر موارد"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"عنصر مورد استفاده برای جدا کردن اقلام آرد سوخاری"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"جدا کننده"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"یک جزء دکمه ای که برای فعال کردن اقدامات یا رویدادها استفاده می شود"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"دکمه"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"عنوان"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"محتوا"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"سایه دکمه را هنگام تنظیم به true حذف می کند"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"ارتفاع را غیرفعال کنید"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"نشانگر بارگذاری را نمایش می دهد و تعامل را غیرفعال می کند"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"بارگیری"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"گروه دکمه های مرتبط با هم"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"گروه دکمه"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"باعث می شود گروه دکمه عرض کامل ظرف را پوشش دهد"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"عرض کامل"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"جهت طرح دکمه ها را تنظیم می کند"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"جهت گیری"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"جزء سطحی برای گروه بندی مطالب مرتبط"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"کارت"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"دکمه های عمل یا کنترل برای کارت"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"اقدامات"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"محتوای ارائه شده در سربرگ کارت"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"هدر"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"عنصر اکشن نمایش داده شده در هدر"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"اقدام هدر"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"عنصر آواتار نمایش داده شده در هدر"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"هدر آواتار"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"محتوای رسانه ای مانند تصویر یا ویدئو"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"رسانه ها"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"تماس برگشت وقتی کارت انتخاب شد"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"ectselect"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"متن ثانویه نمایش داده شده در زیر هدر"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"زیر عنوان"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"بخش اقدامات را در پایین نمایش می دهد"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"از اقدامات استفاده کنید"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"بسته بندی محتوا با یک منطقه عمل قابل کلیک"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"استفاده از منطقه عمل کارت"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"بخش سربرگ کارت را فعال می کند"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"استفاده از هدر"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"یک منطقه عمل را در داخل سرصفحه فعال می کند"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"از header action استفاده کنید"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"یک آواتار را در داخل سر صفحه نمایش می دهد"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"استفاده از هدر آواتار"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"بخش رسانه ای را در داخل کارت فعال می کند"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"از رسانه ها استفاده کنید"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"یک زیرنویس زیر عنوان اصلی را نمایش می دهد"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"از زیر عنوان استفاده کنید"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"اجازه انتخاب یک یا چند گزینه را می دهد"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"جعبه چک"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"حالت بررسی اولیه در صورت عدم کنترل"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"پیش فرض بررسی شده است"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"نشان دهنده بارگذاری یا پیشرفت در یک فرم دایره ای است"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"پیشرفت دایره ای"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"انیمیشن کوچک کننده را غیرفعال می کند"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"کوچک کردن را غیرفعال کنید"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"عرض سکته مغزی دایره را کنترل می کند"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"ضخامت"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"مراکز و محدود کردن محتوا به صورت افقی"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"ظرف"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"به جای عرض مایع ، حداکثر عرض ثابت را تنظیم می کند"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"ثابت"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"حداکثر عرض ظرف را تعریف می کند"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"حداکثر عرض"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"محتوای را بسته بندی می کند و یک حالت خطا یا پیام را نمایش می دهد"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"بسته بندی خطا"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"برچسب را با کنترل فرم مرتبط می کند"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"برچسب کنترل فرم"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"عنصر کنترل فرم (جعبه چک ، رادیو ، سوئیچ)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"کنترل"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"موقعیت برچسب نسبت به کنترل"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"قرار دادن برچسب"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"برچسب برای گروه بندی یا توصیف زمینه های فرم"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"برچسب فرم"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"یک ظاهر طراحی حالت پر شده را اعمال می کند"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"پر شده"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"نشان دهنده بارگذاری یا پیشرفت در یک نوار خطی است"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"پیشرفت خطی"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"مقدار بافر ثانویه برای حالت پیشرفت بافر"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"بافر ارزش"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"عنصر قابل کلیک برای ناوبری یا اقدامات"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"لینک"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"Destinationl مقصد"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Href"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"یک لیست عمودی از آیتم ها را نمایش می دهد"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"لیست"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"نشان دهنده یک آیتم در داخل یک لیست است"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"آیتم لیست"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"یک تقسیم کننده را در زیر آیتم لیست نمایش می دهد"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"تقسیم کننده"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"اجازه انتخاب یک گزینه از یک مجموعه را می دهد"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"گروه رادیویی"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"ویژگی نام برای گروه بندی دکمه های رادیویی استفاده می شود"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"نام"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"دکمه های رادیویی را به صورت افقی نمایش می دهد"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"ردیف"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"یک دکمه رادیویی واحد که در یک گروه رادیویی استفاده می شود"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"مورد رادیو"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"جزء کشویی برای انتخاب گزینه ها"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"انتخاب کنید"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"به طور خودکار میدان را بر روی کوه متمرکز می کند"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"تمرکز خودکار"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"امکان انتخاب گزینه های متعدد"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"چندگانه"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"طرح بندی کودکان در یک پشته یک بعدی"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"پشته"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"کنترل تراز محور متقاطع"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"آیتم ها را تراز کنید"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"تعریف می کند که آیا آیتم ها در یک ردیف یا ستون انباشته شده اند"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"جهت"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"کنترل می کند که آیا آیتم ها روی چندین خط بسته بندی می شوند"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"بسته بندی انعطاف پذیر"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"کنترل تراز محور اصلی"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"محتوای را توجیه کنید"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"فاصله بین اقلام انباشته شده"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"فاصله"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"از فاصله css به جای حاشیه برای فاصله استفاده می کند"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"از flex gap استفاده کنید"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"کنترل ضامن برای تغییر بین دو حالت"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"سوئیچ"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"حالت اولیه ضامن زمانی که کنترل نشده است"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"پیش فرض بررسی شده است"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"فیلد ورودی برای داده های متن و فرم"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"فیلد متن"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"به طور خودکار میدان را بر روی کوه متمرکز می کند"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"تمرکز خودکار"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"حداکثر تعداد ردیف های قابل مشاهده برای ورودی چند خطی"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"حداکثر ردیف"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"یک textarea را به جای یک ورودی تک خطی ارائه می دهد"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"چند خطی"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"نوع ورودی HTML (متن ، رمز عبور ، ایمیل و غیره)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"نوع"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"اطلاعات زمینه ای در مورد شناور ، تمرکز یا لمس را نمایش می دهد"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"نکته ابزار"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"یک تیر را به عنصر هدف نشان می دهد"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"تیر"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"مانع از ظاهر شدن ابزار در فوکوس می شود"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"تمرکز شنونده را غیرفعال کنید"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"مانع از ظاهر شدن ابزار در hover می شود"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"شنونده شناور را غیرفعال کنید"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"تعامل با محتوای ابزار را غیرفعال می کند"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"غیرفعال کردن تعاملی"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"مانع از ظاهر شدن ابزار در لمس می شود"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"شنونده لمسی را غیرفعال کنید"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"تاخیر در میلی ثانیه قبل از نشان دادن ابزار"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"تاخیر را وارد کنید"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"باعث می شود که ابزار از موقعیت نشانگر پیروی کند"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"مکان نما را دنبال کنید"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"تاخیر در میلی ثانیه قبل از پنهان کردن ابزار"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"تاخیر مرخصی"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"محتوای متنی که در داخل ابزار نمایش داده می شود"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"عنوان"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"نمایش متن با سبک های تایپوگرافی از پیش تعریف شده"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"تایپوگرافی"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"محتوای متن"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"محتوا"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"جزء برای آپلود یک یا چند فایل"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"آپلودر"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"انواع فایل های مجاز (به عنوان مثال \".جی پی جی.png\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"قبول کن"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"امکان انتخاب چند فایل"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"چندگانه"`


---

# Variable: muiFormControlLabel

> `const` **muiFormControlLabel**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiFormControlLabelProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiFormControlLabelProps)>


---

# Variable: muiFormLabel

> `const` **muiFormLabel**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`DefaultComponentProps`<`FormLabelTypeMap`<{ }, `"label"`>>>


---

# Variable: muiFrFrComponentsDescriptions

> **muiFrFrComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"Affichage des données"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"Commentaires"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"Forme"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"Entrées"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"Mise en page"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"Navigation"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"Surfaces"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"Si vrai, le composant est vérifié"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"Vérifié"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"Le contenu du composant"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"Enfants"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"La couleur du composant"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"Couleur"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"La valeur par défaut. Utiliser lorsque le composant n'est pas contrôlé"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"Valeur par défaut"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"Si vrai, réduit le remplissage vertical"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"Dense"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"Si vrai, le composant est désactivé"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"Désactivé"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"Si vrai, désactive le remplissage gauche et droit"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"Désactiver les gouttières"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"Si vrai, désactive le remplissage par défaut"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"Désactiver le remplissage"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"Si vrai, le composant est affiché dans un état d'erreur"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"Erreur"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"Si true, le composant occupe toute la largeur de son conteneur"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"Pleine largeur"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"Si vrai, le texte aura une marge inférieure"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"Fond de gouttière"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"Le contenu du texte d'aide"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"Texte d'aide"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"Définit la marge appliquée au composant"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"Marge"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"Si vrai, le texte ne s'enroulera pas, mais sera tronqué avec des points de suspension de débordement de texte"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"Pas d'emballage"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"Rappel déclenché lorsque la valeur est modifiée"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"Changement"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"Rappel déclenché lorsque le composant est cliqué"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"OnClick"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"Si vrai, l'élément d'entrée est requis"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"Requis"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"La taille du composant"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"Taille"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"La prop système qui permet de définir des remplacements système ainsi que des styles CSS supplémentaires"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"Alignement du texte"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"Alignement"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"La valeur du composant"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"Valeur"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"La variante à utiliser"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"Variante"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"Conteneur de mise en page générique avec prise en charge du style système"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"Boîte"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"Affiche l'emplacement actuel de la page dans une hiérarchie"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"Chapelure"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"Éléments de fil d'ariane à afficher"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"Articles"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"Si le nombre maximal d'éléments est dépassé, le nombre d'éléments à afficher après les points de suspension"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"Éléments après effondrement"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"Si le nombre maximal d'éléments est dépassé, le nombre d'éléments à afficher avant les points de suspension"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"Éléments avant l'effondrement"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"Spécifie le nombre maximal de fils d'ariane à afficher"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"Articles maximum"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"Élément utilisé pour séparer les éléments de fil d'ariane"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"Séparateur"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"Composant de bouton utilisé pour déclencher des actions ou des événements"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"Bouton"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"La légende"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"Contenu"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"Supprime l'ombre du bouton lorsqu'il est défini sur true"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"Désactiver l'élévation"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"Affiche un indicateur de chargement et désactive l'interaction"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"Chargement"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"Regroupe les boutons liés ensemble"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"Groupe de boutons"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"Fait en sorte que le groupe de boutons couvre toute la largeur du conteneur"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"Pleine largeur"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"Définit la direction de la disposition des boutons"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"Orientation"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"Composant de surface pour regrouper le contenu associé"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"Carte"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"Boutons d'action ou commandes pour la carte"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"Actions"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"Contenu rendu dans l'en-tête de la carte"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"En-tête"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"Élément d'action affiché dans l'en-tête"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"Action d'en-tête"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"Élément Avatar affiché dans l'en-tête"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"Avatar d'en-tête"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"Contenu multimédia tel qu'une image ou une vidéo"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"Médias"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"Rappel déclenché lorsque la carte est sélectionnée"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"Sélectionner"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"Texte secondaire affiché sous l'en-tête"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"Sous-en-tête"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"Affiche une section actions en bas"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"Utiliser des actions"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"Enveloppe le contenu avec une zone d'action cliquable"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"Utiliser la zone d'action de la carte"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"Active la section d'en-tête de carte"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"Utiliser l'en-tête"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"Active une zone d'action à l'intérieur de l'en-tête"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"Utiliser l'action d'en-tête"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"Affiche un avatar à l'intérieur de l'en-tête"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"Utiliser l'avatar d'en-tête"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"Active une section multimédia à l'intérieur de la carte"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"Utiliser des médias"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"Affiche un sous-en-tête sous l'en-tête principal"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"Utiliser le sous-en-tête"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"Permet de sélectionner une ou plusieurs options"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"Case à Cocher"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"État initial vérifié lorsqu'il n'est pas contrôlé"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"Valeur par défaut cochée"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"Indique le chargement ou la progression sous forme circulaire"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"Progrès circulaire"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"Désactive l'animation de rétrécissement"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"Désactiver la réduction"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"Contrôle la largeur du trait du cercle"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"Épaisseur"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"Centre et contraint le contenu horizontalement"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"Conteneur"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"Définit une largeur maximale fixe au lieu d'une largeur fluide"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"Fixe"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"Définit la largeur maximale du conteneur"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"Largeur maximum"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"Encapsule le contenu et affiche un état ou un message d'erreur"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"Wrapper d'erreur"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"Associe une étiquette à un contrôle de formulaire"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"Étiquette de contrôle de formulaire"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"Élément de contrôle de formulaire (case à cocher, radio, commutateur)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"Contrôle"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"Position de l'étiquette par rapport au contrôle"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"Placement des étiquettes"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"Étiquette pour regrouper ou décrire les champs de formulaire"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"Étiquette de formulaire"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"Applique le style d'état rempli"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"Rempli"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"Indique le chargement ou la progression dans une barre linéaire"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"Progression linéaire"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"Valeur de tampon secondaire pour le mode de progression tamponné"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"Tampon de valeur"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"Élément cliquable pour la navigation ou les actions"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"Lien"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"URL de DESTINATION"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"FRH"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"Affiche une liste verticale d'éléments"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"Liste"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"Représente un seul élément dans une liste"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"Élément de liste"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"Affiche un diviseur sous l'élément de liste"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"Diviseur"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"Permet de sélectionner une seule option dans un ensemble"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"Groupe radio"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"Attribut de nom utilisé pour grouper les boutons radio"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"Nom"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"Affiche les boutons radio horizontalement"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"Rangée"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"Un seul bouton radio utilisé au sein d'un groupe radio"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"Élément radio"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"Composant déroulant pour la sélection des options"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"Sélectionner"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"Focalise automatiquement le champ sur la monture"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"Mise au point automatique"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"Permet de sélectionner plusieurs options"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"Multiples"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"Dispositions des enfants dans une pile unidimensionnelle"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"Pile"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"Contrôle l'alignement des axes croisés"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"Aligner les éléments"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"Définit si les éléments sont empilés dans une ligne ou une colonne"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"Direction Générale"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"Contrôle si les éléments s'enroulent sur plusieurs lignes"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"Enveloppe flexible"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"Contrôle l'alignement de l'axe principal"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"Justifier le contenu"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"Espacement entre les éléments empilés"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"Espacement"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"Utilise l'écart CSS au lieu des marges pour l'espacement"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"Utiliser l'écart flexible"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"Commande à bascule pour basculer entre deux états"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"Commutateur"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"État de basculement initial lorsqu'il n'est pas contrôlé"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"Valeur par défaut cochée"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"Champ de saisie pour les données de texte et de formulaire"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"Champ de texte"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"Focalise automatiquement le champ sur la monture"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"Mise au point automatique"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"Nombre maximal de lignes visibles pour l'entrée multiligne"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"Lignes max"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"Affiche une zone de texte au lieu d'une entrée sur une seule ligne"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"Multiligne"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"Type de saisie HTML (texte, mot de passe, e-mail, etc.)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"Type"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"Affiche des informations contextuelles sur le survol, le focus ou le toucher"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"Infobulle"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"Affiche une flèche pointant vers l'élément cible"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"Flèche"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"Empêche l'info-bulle d'apparaître sur le focus"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"Désactiver l'écouteur de focus"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"Empêche l'infobulle d'apparaître au survol"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"Désactiver l'écouteur de survol"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"Désactive l'interaction avec le contenu de l'info-bulle"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"Désactiver interactif"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"Empêche l'infobulle d'apparaître au toucher"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"Désactiver l'écouteur tactile"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"Délai en millisecondes avant d'afficher l'info-bulle"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"Entrer le délai"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"Fait que l'info-bulle suit la position du curseur"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"Suivre le curseur"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"Délai en millisecondes avant de masquer l'info-bulle"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"Délai de congé"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"Contenu textuel affiché à l'intérieur de l'info-bulle"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"Titre"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"Affiche du texte avec des styles de typographie prédéfinis"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"Typographie"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"Le contenu du texte"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"Contenu"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"Composant pour télécharger un ou plusieurs fichiers"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"Téléchargeur"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"Types de fichiers autorisés (par exemple \".jpg,.png\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"Accepter"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"Permet de sélectionner plusieurs fichiers"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"Multiples"`


---

# Variable: muiHiInComponentsDescriptions

> **muiHiInComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"डेटा प्रदर्शन"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"प्रतिक्रिया"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"फॉर्म"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"इनपुट्स"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"लेआउट"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"नेविगेशन"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"सतहों"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"यदि सही है, तो घटक की जाँच की जाती है"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"जाँच की"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"घटक की सामग्री"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"बच्चे"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"घटक का रंग"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"रंग"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"डिफ़ॉल्ट मान। घटक नियंत्रित नहीं होने पर उपयोग करें"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"डिफ़ॉल्ट मान"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"यदि सही है, तो ऊर्ध्वाधर पैडिंग को कम करता है"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"घना"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"यदि सही है, तो घटक अक्षम है"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"विकलांग"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"यदि सही है, तो बाएं और दाएं पैडिंग को अक्षम करता है"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"गटर अक्षम करें"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"यदि सही है, तो डिफ़ॉल्ट पैडिंग को अक्षम करता है"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"पैडिंग अक्षम करें"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"यदि सही है, तो घटक एक त्रुटि स्थिति में प्रदर्शित होता है"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"त्रुटि"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"यदि सही है, तो घटक अपने कंटेनर की पूरी चौड़ाई लेता है"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"पूरी चौड़ाई"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"यदि सही है, तो पाठ का निचला मार्जिन होगा"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"गटर नीचे"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"सहायक पाठ सामग्री"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"सहायक पाठ"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"घटक पर लागू मार्जिन को परिभाषित करता है"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"मार्जिन"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"यदि सही है, तो पाठ लपेट नहीं जाएगा, बल्कि इसके बजाय एक पाठ अतिप्रवाह दीर्घवृत्त के साथ छोटा हो जाएगा"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"कोई लपेटो"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"मान बदलने पर कॉलबैक निकाल दिया गया"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"ऑनचेंज"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"जब घटक क्लिक किया जाता है तो कॉलबैक निकाल दिया जाता है"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"ऑनक्लिक"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"यदि सही है, तो इनपुट तत्व की आवश्यकता है"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"आवश्यक है"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"घटक का आकार"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"आकार"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"सिस्टम प्रोप जो सिस्टम को परिभाषित करने की अनुमति देता है और साथ ही अतिरिक्त सीएसएस शैलियों को भी ओवरराइड करता है"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"एसएक्स"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"पाठ संरेखण"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"संरेखण"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"घटक का मूल्य"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"मूल्य"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"उपयोग करने के लिए संस्करण"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"वेरिएंट"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"सिस्टम स्टाइल समर्थन के साथ जेनेरिक लेआउट कंटेनर"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"बॉक्स"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"पदानुक्रम के भीतर वर्तमान पृष्ठ स्थान दिखाता है"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"ब्रेडक्रंब"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"प्रदर्शित करने के लिए ब्रेडक्रंब आइटम"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"आइटम"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"यदि अधिकतम आइटम पार हो गए हैं, तो दीर्घवृत्त के बाद दिखाने के लिए वस्तुओं की संख्या"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"पतन के बाद आइटम"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"यदि अधिकतम आइटम पार हो गए हैं, तो दीर्घवृत्त से पहले दिखाने के लिए वस्तुओं की संख्या"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"पतन से पहले आइटम"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"प्रदर्शित करने के लिए ब्रेडक्रंब की अधिकतम संख्या निर्दिष्ट करता है"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"अधिकतम आइटम"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"ब्रेडक्रंब आइटम को अलग करने के लिए प्रयुक्त तत्व"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"सेपरेटर"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"क्रियाओं या घटनाओं को ट्रिगर करने के लिए उपयोग किया जाने वाला एक बटन घटक"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"बटन"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"कैप्शन"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"सामग्री"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"सत्य पर सेट होने पर बटन छाया को हटा देता है"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"ऊंचाई अक्षम करें"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"एक लोडिंग संकेतक प्रदर्शित करता है और इंटरैक्शन को अक्षम करता है"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"लोड हो रहा है"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"समूह संबंधित बटन एक साथ"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"बटन समूह"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"बटन समूह को पूर्ण कंटेनर चौड़ाई का विस्तार करता है"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"पूरी चौड़ाई"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"बटन की लेआउट दिशा सेट करता है"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"अभिविन्यास"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"संबंधित सामग्री को समूहीकृत करने के लिए भूतल घटक"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"कार्ड"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"कार्ड के लिए एक्शन बटन या नियंत्रण"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"क्रियाएँ"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"कार्ड हेडर में प्रदान की गई सामग्री"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"हैडर"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"हेडर में प्रदर्शित एक्शन तत्व"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"हैडर एक्शन"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"हेडर में प्रदर्शित अवतार तत्व"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"हैडर अवतार"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"मीडिया सामग्री जैसे कि एक छवि या वीडियो"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"मीडिया"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"कार्ड चुने जाने पर कॉलबैक ट्रिगर हो जाता है"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"एकचयन करें"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"हेडर के नीचे प्रदर्शित द्वितीयक पाठ"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"उप हैडर"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"तल पर एक क्रिया अनुभाग प्रदर्शित करता है"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"क्रियाओं का उपयोग करें"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"एक क्लिक करने योग्य कार्रवाई क्षेत्र के साथ सामग्री लपेटता है"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"कार्ड एक्शन एरिया का उपयोग करें"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"कार्ड हेडर अनुभाग सक्षम करता है"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"हेडर का उपयोग करें"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"हेडर के अंदर एक क्रिया क्षेत्र सक्षम करता है"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"हेडर एक्शन का उपयोग करें"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"हेडर के अंदर एक अवतार प्रदर्शित करता है"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"हेडर अवतार का उपयोग करें"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"कार्ड के अंदर एक मीडिया अनुभाग सक्षम करता है"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"मीडिया का उपयोग करें"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"मुख्य हेडर के नीचे एक सबहेडर प्रदर्शित करता है"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"सबहेडर का उपयोग करें"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"एक या अधिक विकल्प चुनने की अनुमति देता है"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"चेकबॉक्स"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"अनियंत्रित होने पर प्रारंभिक जाँच की गई स्थिति"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"डिफ़ॉल्ट जाँच की"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"वृत्ताकार रूप में लोडिंग या प्रगति को इंगित करता है"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"परिपत्र प्रगति"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"हटना एनीमेशन अक्षम करता है"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"हटना अक्षम करें"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"सर्कल की स्ट्रोक चौड़ाई को नियंत्रित करता है"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"मोटाई"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"केंद्र और बाधा सामग्री क्षैतिज रूप से"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"कंटेनर"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"एक तरल पदार्थ के बजाय एक निश्चित अधिकतम चौड़ाई सेट करता है"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"फिक्स्ड"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"कंटेनर की अधिकतम चौड़ाई को परिभाषित करता है"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"अधिकतम चौड़ाई"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"सामग्री लपेटता है और एक त्रुटि स्थिति या संदेश प्रदर्शित करता है"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"त्रुटि आवरण"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"एक फॉर्म नियंत्रण के साथ एक लेबल को संबद्ध करता है"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"प्रपत्र नियंत्रण लेबल"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"प्रपत्र नियंत्रण तत्व (चेकबॉक्स, रेडियो, स्विच)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"नियंत्रण"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"नियंत्रण के सापेक्ष लेबल की स्थिति"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"लेबल प्लेसमेंट"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"प्रपत्र फ़ील्ड को समूहीकृत करने या वर्णन करने के लिए लेबल"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"फॉर्म लेबल"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"भरा राज्य स्टाइल लागू होता है"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"भरा हुआ"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"लीनियर बार में लोडिंग या प्रगति को इंगित करता है"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"रैखिक प्रगति"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"बफर प्रगति मोड के लिए माध्यमिक बफर मूल्य"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"मूल्य बफर"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"नेविगेशन या कार्यों के लिए क्लिक करने योग्य तत्व"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"लिंक"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"गंतव्य यूआरएल"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"एचआरईएफ"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"वस्तुओं की एक ऊर्ध्वाधर सूची प्रदर्शित करता है"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"सूची"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"एक सूची के अंदर एक आइटम का प्रतिनिधित्व करता है"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"सूची आइटम"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"सूची आइटम के नीचे एक विभक्त प्रदर्शित करता है"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"विभक्त"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"एक सेट से एक विकल्प का चयन करने की अनुमति देता है"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"रेडियो समूह"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"रेडियो बटनों को समूहित करने के लिए प्रयुक्त नाम विशेषता"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"नाम"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"क्षैतिज रूप से रेडियो बटन प्रदर्शित करता है"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"पंक्ति"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"एक रेडियो समूह के भीतर एक एकल रेडियो बटन का उपयोग किया जाता है"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"रेडियो आइटम"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"विकल्प चुनने के लिए ड्रॉपडाउन घटक"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"का चयन करें"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"स्वचालित रूप से माउंट पर क्षेत्र केंद्रित है"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"ऑटो फोकस"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"कई विकल्प चुनने की अनुमति देता है"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"एकाधिक"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"एक आयामी ढेर में लेआउट बच्चों"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"ढेर"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"नियंत्रण क्रॉस-अक्ष संरेखण"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"आइटम संरेखित करें"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"परिभाषित करता है कि आइटम एक पंक्ति या स्तंभ में खड़ी हैं या नहीं"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"दिशा"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"नियंत्रण क्या आइटम कई लाइनों पर लपेटते हैं"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"फ्लेक्स लपेटें"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"नियंत्रण मुख्य अक्ष संरेखण"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"सामग्री को सही ठहराएं"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"स्टैक्ड आइटम के बीच रिक्ति"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"रिक्ति"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"रिक्ति के लिए मार्जिन के बजाय सीएसएस गैप का उपयोग करता है"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"फ्लेक्स गैप का उपयोग करें"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"दो राज्यों के बीच स्विच करने के लिए नियंत्रण टॉगल करें"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"स्विच करें"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"अनियंत्रित होने पर प्रारंभिक टॉगल स्थिति"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"डिफ़ॉल्ट जाँच की"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"पाठ और प्रपत्र डेटा के लिए इनपुट फ़ील्ड"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"पाठ क्षेत्र"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"स्वचालित रूप से माउंट पर क्षेत्र केंद्रित है"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"ऑटो फोकस"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"मल्टीलाइन इनपुट के लिए दृश्यमान पंक्तियों की अधिकतम संख्या"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"अधिकतम पंक्तियाँ"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"एकल-पंक्ति इनपुट के बजाय एक टेक्स्टरेरा प्रस्तुत करता है"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"मल्टीलाइन"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"एचटीएमएल इनपुट प्रकार (पाठ, पासवर्ड, ईमेल, आदि)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"प्रकार"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"होवर, फ़ोकस या टच पर प्रासंगिक जानकारी प्रदर्शित करता है"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"टूलटिप"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"लक्ष्य तत्व की ओर इशारा करते हुए एक तीर प्रदर्शित करता है"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"तीर"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"टूलटिप को फोकस पर प्रदर्शित होने से रोकता है"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"फोकस श्रोता अक्षम करें"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"टूलटिप को होवर पर प्रदर्शित होने से रोकता है"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"होवर श्रोता अक्षम करें"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"टूलटिप सामग्री के साथ सहभागिता अक्षम करता है"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"इंटरैक्टिव अक्षम करें"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"टूलटिप को स्पर्श पर प्रदर्शित होने से रोकता है"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"स्पर्श श्रोता अक्षम करें"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"टूलटिप दिखाने से पहले मिलीसेकंड में देरी"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"देरी दर्ज करें"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"टूलटिप कर्सर स्थिति का पालन करता है"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"कर्सर का पालन करें"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"टूलटिप को छिपाने से पहले मिलीसेकंड में देरी"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"देरी छोड़ें"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"टूलटिप के अंदर प्रदर्शित पाठ सामग्री"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"शीर्षक"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"पूर्वनिर्धारित टाइपोग्राफी शैलियों के साथ पाठ प्रदर्शित करता है"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"टाइपोग्राफी"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"पाठ सामग्री"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"सामग्री"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"एक या अधिक फ़ाइलों को अपलोड करने के लिए घटक"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"अपलोडर"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"अनुमत फ़ाइल प्रकार (जैसे\" ।जेपीजी, । पीएनजी\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"स्वीकार करें"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"एकाधिक फ़ाइलों का चयन करने की अनुमति देता है"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"एकाधिक"`


---

# Variable: muiItItComponentsDescriptions

> **muiItItComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"Visualizzazione dei dati"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"Feedback"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"Forma"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"Input"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"Layout"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"Navigazione"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"Superficie"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"Se true, il componente viene selezionato"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"Verificare"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"Il contenuto del componente"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"Bambino"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"Il colore del componente"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"Colore"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"Il valore predefinito. Utilizzare quando il componente non è controllato"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"Valore predefinito"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"Se vero, riduce il riempimento verticale"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"Denso"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"Se true, il componente è disabilitato"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"Disabilita"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"Se true, disabilita il padding sinistro e destro"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"Disabilita grondaie"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"Se true, disabilita il padding predefinito"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"Disabilita padding"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"Se true, il componente viene visualizzato in uno stato di errore"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"Errore"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"Se true, il componente occupa l'intera larghezza del suo contenitore"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"Larghezza completa"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"Se vero, il testo avrà un margine inferiore"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"Fondo della grondaia"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"Il contenuto del testo helper"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"Testo Helper"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"Definisce il margine applicato al componente"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"Margine"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"Se è vero, il testo non verrà chiuso, ma verrà invece troncato con un puntini di sospensione di overflow del testo"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"Nessun involucro"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"Callback attivato quando il valore viene modificato"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"onChange"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"Callback attivato quando si fa clic sul componente"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"onClick"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"Se true, l'elemento di input è richiesto"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"Necessario"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"La dimensione del componente"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"Dimensione"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"Il prop di sistema che consente la definizione di override di sistema e di stili CSS aggiuntivi"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"Allineamento testo"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"Allineamento"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"Il valore del componente"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"Valore"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"La variante da utilizzare"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"Variante"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"Contenitore di layout generico con supporto per lo stile del sistema"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"Scatola"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"Mostra la posizione della pagina corrente all'interno di una gerarchia"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"Mollica"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"Elementi Breadcrumb da visualizzare"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"Elemento"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"Se viene superato il numero massimo di elementi, il numero di elementi da mostrare dopo i puntini di sospensione"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"Elementi dopo il collasso"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"Se viene superato il numero massimo di elementi, il numero di elementi da mostrare prima dei puntini di sospensione"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"Elementi prima del collasso"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"Specifica il numero massimo di breadcrumb da visualizzare"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"Max articoli"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"Elemento utilizzato per separare gli elementi breadcrumb"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"Separatore"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"Un componente pulsante utilizzato per attivare azioni o eventi"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"Pulsante"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"Didascalia"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"Contenuto"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"Rimuove l'ombra del pulsante quando è impostato su true"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"Disabilita elevazione"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"Visualizza un indicatore di caricamento e disabilita l'interazione"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"Caricamento"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"Raggruppa i pulsanti correlati insieme"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"Gruppo di pulsanti"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"Consente al gruppo di pulsanti di coprire l'intera larghezza del contenitore"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"Larghezza completa"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"Imposta la direzione del layout dei pulsanti"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"Orientamento"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"Componente Surface per il raggruppamento di contenuti correlati"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"Carta"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"Pulsanti di azione o controlli per la scheda"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"Azione"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"Contenuto reso nell'intestazione della carta"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"Intestazione"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"Elemento azione visualizzato nell'intestazione"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"Azione intestazione"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"Elemento Avatar visualizzato nell'intestazione"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"Intestazione avatar"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"Contenuti multimediali come un'immagine o un video"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"Media"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"Callback attivato quando la scheda è selezionata"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"onSelect"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"Testo secondario visualizzato sotto l'intestazione"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"Intestazione secondaria"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"Visualizza una sezione azioni in basso"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"Usa azioni"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"Avvolge il contenuto con un'area di azione cliccabile"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"Usa area di azione della carta"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"Abilita la sezione intestazione scheda"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"Usa intestazione"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"Abilita un'area di azione all'interno dell'intestazione"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"Usa azione intestazione"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"Visualizza un avatar all'interno dell'intestazione"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"Usa intestazione avatar"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"Abilita una sezione multimediale all'interno della scheda"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"Usa media"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"Visualizza un sottotitolo sotto l'intestazione principale"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"Usa il sottotitolo"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"Consente di selezionare una o più opzioni"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"Casella"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"Stato iniziale controllato quando non controllato"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"Predefinito controllato"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"Indica il caricamento o l'avanzamento in forma circolare"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"Progresso circolare"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"Disabilita l'animazione di riduzione"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"Disabilita restringimento"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"Controlla la larghezza del tratto del cerchio"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"Spessore"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"Centra e vincola il contenuto orizzontalmente"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"Contenitore"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"Imposta una larghezza massima fissa invece di una fluida"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"Fisso"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"Definisce la larghezza massima del contenitore"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"Larghezza massima"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"Avvolge il contenuto e visualizza uno stato o un messaggio di errore"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"Wrapper errore"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"Associa un'etichetta a un controllo modulo"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"Etichetta di controllo del modulo"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"Modulo elemento di controllo (casella di controllo, radio, interruttore)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"Controllo"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"Posizione dell'etichetta rispetto al controllo"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"Posizionamento dell'etichetta"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"Etichetta per raggruppare o descrivere i campi modulo"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"Etichetta del modulo"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"Applica lo stile dello stato riempito"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"Riempire"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"Indica il caricamento o l'avanzamento in una barra lineare"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"Progresso lineare"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"Valore del buffer secondario per la modalità di avanzamento del buffer"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"Valore buffer"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"Elemento cliccabile per la navigazione o le azioni"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"Link"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"URL di destinazione"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Href"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"Visualizza un elenco verticale di elementi"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"Elenco"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"Rappresenta un singolo elemento all'interno di un elenco"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"Voce di elenco"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"Visualizza un divisore sotto l'elemento dell'elenco"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"Divisore"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"Consente di selezionare una singola opzione da un set"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"Gruppo radio"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"Attributo Name usato per raggruppare i pulsanti di opzione"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"Nome"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"Visualizza i pulsanti di opzione orizzontalmente"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"Fila"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"Un singolo pulsante di opzione utilizzato all'interno di un gruppo radio"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"Voce radio"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"Componente a discesa per la selezione delle opzioni"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"Selezionare"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"Mette a fuoco automaticamente il campo sul monte"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"Autofocus"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"Consente di selezionare più opzioni"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"Multiplo"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"Layout bambini in una pila unidimensionale"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"Stack"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"Controlla l'allineamento tra assi"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"Allinea elementi"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"Definisce se gli elementi sono impilati in una riga o colonna"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"Direzione"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"Controlla se gli elementi si sovrappongono su più righe"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"Flex wrap"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"Controlla l'allineamento dell'asse principale"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"Giustifica il contenuto"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"Spaziatura tra elementi impilati"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"Spaziatura"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"Utilizza CSS gap invece di margini per la spaziatura"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"Utilizzare flex gap"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"Controllo toggle per la commutazione tra due stati"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"Switch"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"Stato di commutazione iniziale quando non controllato"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"Predefinito controllato"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"Campo di input per i dati di testo e modulo"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"Campo di testo"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"Mette a fuoco automaticamente il campo sul monte"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"Autofocus"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"Numero massimo di righe visibili per l'input multilinea"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"Max righe"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"Esegue il rendering di un'area di testo anziché di un input a riga singola"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"Multiriga"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"Tipo di input HTML (testo, password, e-mail, ecc.)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"Tipo"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"Visualizza le informazioni contestuali al passaggio del mouse, al fuoco o al tocco"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"Tooltip"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"Visualizza una freccia che punta all'elemento di destinazione"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"Freccia"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"Impedisce che il tooltip appaia a fuoco"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"Disabilita listener di messa a fuoco"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"Impedisce che il tooltip appaia al passaggio del mouse"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"Disabilita il listener hover"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"Disabilita l'interazione con il contenuto del tooltip"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"Disabilita interattivo"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"Impedisce che il tooltip appaia al tocco"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"Disabilita touch listener"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"Ritardo in millisecondi prima di mostrare il tooltip"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"Inserisci ritardo"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"Fa in modo che il suggerimento segua la posizione del cursore"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"Segui il cursore"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"Ritardo in millisecondi prima di nascondere il tooltip"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"Lasciare il ritardo"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"Contenuto del testo visualizzato all'interno del tooltip"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"Titolo"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"Visualizza testo con stili tipografici predefiniti"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"Tipografia"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"Il contenuto del testo"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"Contenuto"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"Componente per il caricamento di uno o più file"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"Uploader"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"Tipi di file consentiti (ad es. \".jpg,.png\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"Accettare"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"Consente di selezionare più file"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"Multiplo"`


---

# Variable: muiJaJpComponentsDescriptions

> **muiJaJpComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"データ表示"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"フィードバック"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"フォーム"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"入力"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"レイアウト"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"ナビゲーション"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"表面"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"Trueの場合、コンポーネントがチェックされます"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"チェック済み"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"コンポーネントのコンテンツ"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"子供たち"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"コンポーネントの色"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"色"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"デフォルト値。 コンポーネントが制御されていない場合に使用します"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"デフォルト値"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"Trueの場合、垂直方向のパディングが減少します"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"密な"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"Trueの場合、コンポーネントは無効になります"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"無効"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"Trueの場合、左右のパディングを無効にします"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"雨どいを無効にする"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"Trueの場合、デフォルトのパディングを無効にします"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"パディングを無効にする"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"Trueの場合、コンポーネントはエラー状態で表示されます"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"エラー"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"Trueの場合、コンポーネントはコンテナの全幅を占有します"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"全幅"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"Trueの場合、テキストには下余白があります"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"溝の底"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"ヘルパーテキストの内容"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"ヘルパーテキスト"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"コンポーネントに適用されるマージンを定義します"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"証拠金"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"Trueの場合、テキストは折り返されませんが、代わりにテキストオーバーフロー省略記号で切り捨てられます"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"ラップなし"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"値が変更されたときに発生するコールバック"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"オンチェンジ"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"コンポーネントがクリックされたときに発生するコールバック"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"onClick"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"Trueの場合、input要素は必須です"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"必須"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"コンポーネントのサイズ"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"サイズ"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"システムオーバーライドと追加のCSSスタイルを定義できるシステムプロップ"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"テキストの配置"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"アライメント"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"コンポーネントの値"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"値"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"使用するバリアント"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"変型"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"システムスタイルをサポートする汎用レイアウトコンテナ"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"ボックス"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"階層内の現在のページの場所を表示します"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"ブレッドクラム"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"表示するブレッドクラム項目"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"アイテム"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"最大項目数を超えると、省略記号の後に表示される項目の数が表示されます"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"崩壊後のアイテム"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"最大項目数を超えると、省略記号の前に表示される項目の数が表示されます"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"崩壊前のアイテム"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"表示するブレッドクラムの最大数を指定します"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"最大アイテム数"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"ブレッドクラム項目を分離するために使用される要素"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"セパレータ"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"アクションまたはイベントをトリガーするために使用されるボタンコンポーネント"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"ボタン"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"キャプション"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"コンテンツ"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"Trueに設定されている場合、ボタンの影を削除します"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"昇格を無効にする"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"読み込みインジケータを表示し、対話を無効にします"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"積み込み"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"関連するボタンをまとめてグループ化する"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"ボタングループ"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"ボタングループをコンテナの幅全体に広げます"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"全幅"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"ボタンのレイアウト方向を設定します"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"オリエンテーション"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"関連コンテンツをグループ化するためのサーフェスコンポーネント"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"カード"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"カードのアクションボタンまたはコントロール"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"アクション"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"カードヘッダーにレンダリングされたコンテンツ"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"ヘッダー"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"ヘッダーに表示されるアクション要素"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"ヘッダーアクション"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"ヘッダーに表示されるアバター要素"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"ヘッダーアバター"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"画像やビデオなどのメディアコンテンツ"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"メディア"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"カードが選択されたときにトリガーされるコールバック"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"onSelect"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"ヘッダーの下に表示されるセカンダリテキスト"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"サブヘッダー"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"下部にアクションセクションを表示します"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"アクションを使用する"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"クリック可能なアクション領域でコンテンツをラップします"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"カードアクション領域を使用する"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"カードヘッダセクションを有効にします"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"ヘッダーを使う"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"ヘッダー内のアクション領域を有効にします"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"ヘッダーアクションを使用する"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"ヘッダー内にアバターを表示します"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"ヘッダーアバターを使用する"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"カード内のメディアセクションを有効にします"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"メディアを使う"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"メインヘッダーの下にサブヘッダーを表示します"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"小見出しを使う"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"一つ以上のオプションを選択できます"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"チェックボックス"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"制御されていないときの最初のチェック状態"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"デフォルトチェック"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"循環形式での読み込みまたは進行状況を示します"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"循環の進行状況"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"縮小アニメーションを無効にします"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"縮小を無効にする"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"円のストローク幅を制御します"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"厚さ"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"コンテンツを水平方向に中央揃えおよび制約します"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"コンテナ"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"流体の幅の代わりに固定された最大幅を設定します"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"固定"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"コンテナの最大幅を定義します"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"最高の幅"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"コンテンツをラップし、エラー状態またはメッセージを表示します"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"エラーラッパー"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"ラベルをフォームコントロールに関連付けます"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"フォームコントロールラベル"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"フォーム制御要素（チェックボックス、ラジオ、スイッチ）"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"制御"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"コントロールに対するラベルの位置"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"ラベルの配置"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"フォームフィールドをグループ化または記述するためのラベル"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"フォームラベル"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"塗りつぶされた状態のスタイルを適用します"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"満たされた"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"線形バーでの読み込みまたは進行状況を示します"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"線形進行"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"バッファされた進行状況モードのセカンダリバッファ値"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"値バッファ"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"ナビゲーションまたはアクションのクリック可能な要素"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"リンク"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"リンク先URL"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Href"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"項目の縦方向のリストを表示します"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"リスト"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"リスト内の単一の項目を表します"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"リスト項目"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"リスト項目の下に分周器を表示します"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"ディバイダー"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"セットから単一のオプションを選択できます"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"ラジオグループ"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"ラジオボタンをグループ化するために使用されるName属性"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"名前"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"ラジオボタンを水平方向に表示します"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"行"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"ラジオグループ内で使用される単一のラジオボタン"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"ラジオアイテム"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"オプションを選択するためのドロップダウンコンポーネント"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"選択"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"自動的に台紙に分野を焦点を合わせます"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"オートフォーカス"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"複数のオプションを選択できます"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"複数"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"一次元スタック内のレイアウトの子"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"スタック"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"クロス軸の配置を制御します"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"アイテムの整列"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"項目を行または列に積み重ねるかどうかを定義します"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"方向"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"項目を複数の行に折り返すかどうかを制御します"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"フレックスラップ"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"主軸のアライメントを制御します"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"コンテンツの正当化"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"積み重ねられた項目間の間隔"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"間隔"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"間隔に余白の代わりにCSSギャップを使用します"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"フレックスギャップを使う"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"二つの状態を切り替えるためのトグル制御"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"スイッチ"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"制御されていないときの初期トグル状態"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"デフォルトチェック"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"テキストおよびフォームデータの入力フィールド"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"テキストフィールド"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"自動的に台紙に分野を焦点を合わせます"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"オートフォーカス"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"複数行入力の可視行の最大数"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"最大行数"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"単一行入力の代わりにtextareaをレンダリングします"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"マルチライン"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"HTML入力タイプ（テキスト、パスワード、電子メールなど）)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"タイプ"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"ホバー、フォーカス、またはタッチのコンテキスト情報を表示します"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"ツールチップ"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"ターゲット要素を指す矢印を表示します"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"アロー"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"ツールチップがフォーカスに表示されないようにします"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"フォーカスリスナーを無効にする"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"ツールチップがホバーに表示されないようにします"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"ホバーリスナーを無効にする"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"ツールヒントのコンテンツとの対話を無効にします"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"インタラクティブを無効にする"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"タッチ時にツールチップが表示されないようにします"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"タッチリスナを無効にする"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"ツールヒントを表示する前のミリ秒単位の遅延"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"遅延を入力します"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"ツールチップをカーソル位置に追従させます"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"カーソルに従ってください"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"ツールチップを非表示にするまでの遅延をミリ秒単位で指定します"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"遅延を残す"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"ツールチップ内に表示されるテキストコンテンツ"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"タイトル"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"定義済みのタイポグラフィスタイルを持つテキストを表示します"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"タイポグラフィ"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"テキストの内容"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"コンテンツ"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"1つ以上のファイルをアップロードするためのコンポーネント"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"アップローダー"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"許可されるファイルタイプ(例:\".jpg、。png\"）"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"受け入れる"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"複数のファイルを選択できるようにします"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"複数"`


---

# Variable: muiKoKrComponentsDescriptions

> **muiKoKrComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"데이터 표시"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"피드백"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"양식"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"입력"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"레이아웃"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"탐색"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"표면"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"참인 경우 구성 요소가 확인됩니다"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"체크"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"구성 요소의 내용"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"어린이"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"구성 요소의 색상"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"색상"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"기본값입니다. 구성 요소가 제어되지 않을 때 사용"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"기본값"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"사실 인 경우 수직 패딩을 줄입니다"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"밀도"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"해당되는 경우 구성 요소가 비활성화됩니다"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"사용 안 함"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"참인 경우 왼쪽 및 오른쪽 패딩을 비활성화합니다"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"홈통 비활성화"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"참인 경우 기본 패딩을 비활성화합니다"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"패딩 비활성화"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"참인 경우 구성 요소가 오류 상태로 표시됩니다"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"오류"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"만약 사실이라면,구성 요소는 컨테이너의 전체 너비를 차지합니다."`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"가득 차있는 폭"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"만약 사실이라면,텍스트는 하단 여백을 갖게 될 것입니다."`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"거터 바닥"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"도우미 텍스트 내용"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"도우미 텍스트"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"구성 요소에 적용된 여백을 정의합니다"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"마진"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"참이면 텍스트가 줄 바꿈되지 않고 텍스트 오버플로 줄임표 대신 잘립니다"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"포장 없음"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"값이 변경 될 때 콜백이 발생합니다"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"변경"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"구성 요소를 클릭하면 콜백이 실행됩니다"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"온클릭"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"참인 경우 입력 요소가 필요합니다"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"필수"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"구성 요소의 크기"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"크기"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"시스템 재정의 및 추가 스타일을 정의할 수 있는 시스템 소품"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"에스엑스"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"텍스트 정렬"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"정렬"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"구성 요소의 값"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"값"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"사용할 변형"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"변종"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"시스템 스타일을 지원하는 일반 레이아웃 컨테이너"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"상자"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"계층 내에서 현재 페이지 위치를 표시합니다"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"빵 부스러기"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"표시할 이동 경로 항목"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"항목"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"최대 항목을 초과하면 줄임표 뒤에 표시할 항목 수입니다"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"축소 후 항목"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"최대 항목을 초과하면 줄임표 앞에 표시할 항목 수입니다"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"축소 전 항목"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"표시할 최대 이동 경로 수를 지정합니다"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"최대 항목"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"이동 경로 항목을 분리하는 데 사용되는 요소"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"분리기"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"작업 또는 이벤트를 트리거하는 데 사용되는 단추 구성 요소"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"버튼"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"캡션"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"내용"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"참으로 설정하면 단추 그림자를 제거합니다"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"상승 비활성화"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"로드 표시기를 표시하고 상호 작용을 비활성화합니다"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"로드 중"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"관련 버튼을 함께 그룹화"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"버튼 그룹"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"단추 그룹을 전체 컨테이너 너비에 걸쳐 만듭니다"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"가득 차있는 폭"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"단추의 레이아웃 방향을 설정합니다"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"방향"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"관련 콘텐츠 그룹화를 위한 표면 구성 요소"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"카드"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"카드의 동작 버튼 또는 컨트롤"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"행동"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"카드 헤더에 렌더링된 콘텐츠"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"헤더"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"헤더에 표시된 작업 요소"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"헤더 동작"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"헤더에 표시된 아바타 요소"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"헤더 아바타"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"이미지 또는 비디오와 같은 미디어 콘텐츠"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"미디어"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"카드를 선택하면 콜백이 트리거됩니다"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"선택"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"머리글 아래에 표시되는 보조 텍스트"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"서브 헤더"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"아래쪽에 작업 섹션을 표시합니다"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"작업 사용"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"클릭 가능한 작업 영역으로 콘텐츠를 래핑합니다"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"카드 작업 영역 사용"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"카드 헤더 섹션을 활성화합니다"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"헤더 사용"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"헤더 내부의 작업 영역을 활성화합니다"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"헤더 작업 사용"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"헤더 안에 아바타를 표시합니다"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"헤더 아바타 사용"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"카드 내부의 미디어 섹션을 활성화합니다"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"미디어 사용"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"주 헤더 아래에 하위 헤더를 표시합니다"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"서브 헤더 사용"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"하나 이상의 옵션을 선택할 수 있습니다"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"체크박스"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"통제되지 않은 경우 초기 검사 상태"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"기본값 선택"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"순환 형태로 로드 또는 진행 상황을 나타냅니다"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"순환 진행"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"축소 애니메이션 비활성화"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"축소 비활성화"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"원의 획 폭을 제어합니다"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"두께"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"콘텐츠를 가로로 가운데 및 제한"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"컨테이너"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"유체 너비 대신 고정 최대 너비를 설정합니다"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"고정"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"컨테이너의 최대 너비를 정의합니다"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"최대 폭"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"콘텐츠를 래핑하고 오류 상태 또는 메시지를 표시합니다"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"오류 래퍼"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"레이블을 양식 컨트롤과 연결"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"양식 제어 레이블"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"양식 제어 요소(체크 박스,라디오,스위치)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"제어"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"컨트롤에 대한 레이블의 위치"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"라벨 배치"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"양식 필드를 그룹화하거나 설명하는 레이블"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"양식 레이블"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"채워진 상태 스타일 적용"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"채워진"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"선형 막대에서 로드 또는 진행 상황을 나타냅니다"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"선형 진행"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"버퍼링된 진행 모드의 보조 버퍼 값"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"값 버퍼"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"탐색 또는 작업을 위해 클릭 가능한 요소"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"링크"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"목적지"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"헤프"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"항목의 수직 목록을 표시합니다"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"목록"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"목록 내의 단일 항목을 나타냅니다"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"목록 항목"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"목록 항목 아래에 구분선을 표시합니다"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"분할기"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"집합에서 단일 옵션을 선택할 수 있습니다"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"라디오 그룹"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"라디오 단추를 그룹화하는 데 사용되는 이름 속성"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"이름"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"라디오 버튼을 수평으로 표시합니다."`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"행"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"라디오 그룹 내에서 사용되는 단일 라디오 버튼"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"라디오 항목"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"옵션 선택을위한 드롭 다운 구성 요소"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"선택"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"자동으로 마운트에 필드를 집중"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"자동 초점"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"여러 옵션을 선택할 수 있습니다"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"다중"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"1 차원 스택의 레이아웃 어린이"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"스택"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"교차 축 정렬을 제어합니다"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"항목 정렬"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"항목이 행 또는 열에 누적되는지 여부를 정의합니다"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"방향"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"항목이 여러 줄로 줄 바꿈 여부를 제어합니다"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"플렉스 랩"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"주축 정렬을 제어합니다"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"콘텐츠 정당화"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"누적 된 항목 사이의 간격"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"간격"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"간격에 여백 대신 간격 사용"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"플렉스 갭 사용"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"두 상태 간 전환을 위한 토글 제어"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"스위치"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"제어되지 않은 경우 초기 토글 상태"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"기본값 선택"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"텍스트 및 양식 데이터의 입력 필드"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"텍스트 필드"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"자동으로 마운트에 필드를 집중"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"자동 초점"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"여러 줄 입력에 대해 표시되는 최대 행 수"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"최대 행"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"한 줄 입력 대신 텍스트 영역을 렌더링합니다"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"여러 줄"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"입력 유형(텍스트,비밀번호,이메일 등))"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"유형"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"호버,포커스 또는 터치에 대한 상황별 정보를 표시합니다"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"툴팁"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"대상 요소를 가리키는 화살표를 표시합니다"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"화살표"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"도구 설명이 포커스에 나타나지 않도록 합니다"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"포커스 리스너 비활성화"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"마우스에 도구 설명이 나타나지 않도록 합니다"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"호버 리스너 비활성화"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"도구 설명 콘텐츠와의 상호 작용을 비활성화합니다"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"대화식 비활성화"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"터치 시 툴팁이 나타나지 않도록 합니다"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"터치 리스너 비활성화"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"도구 설명을 표시하기 전에 밀리 초 지연"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"지연 입력"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"툴팁이 커서 위치를 따르도록 합니다"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"커서를 따라"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"도구 설명을 숨기기 전에 밀리 초 지연"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"지연 휴가"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"도구 설명 안에 표시되는 텍스트 내용"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"제목"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"미리 정의된 타이포그래피 스타일로 텍스트를 표시합니다"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"타이포그래피"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"텍스트 내용"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"내용"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"하나 이상의 파일을 업로드하기 위한 구성 요소"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"업 로더"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"허용된 파일 형식(예:\".-그래,그래\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"동의"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"여러 파일을 선택할 수 있습니다"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"다중"`


---

# Variable: muiLinearProgress

> `const` **muiLinearProgress**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`LinearProgressProps`>


---

# Variable: muiLink

> `const` **muiLink**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`LinkProps`>


---

# Variable: muiList

> `const` **muiList**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`Omit`<[`MuiListProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiListProps), `"ref"`> & `RefAttributes`<`HTMLUListElement`>>


---

# Variable: muiListItem

> `const` **muiListItem**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`Omit`<[`MuiListItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiListItemProps), `"ref"`> & `RefAttributes`<`HTMLLIElement`>>


---

# Variable: muiRadioGroup

> `const` **muiRadioGroup**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`RadioGroupProps` & [`MuiFormControlProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiFormControlProps)>


---

# Variable: muiRadioItem

> `const` **muiRadioItem**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiRadioItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiRadioItemProps)>

Material UI RadioItem component definition for the form builder.


---

# Variable: muiSelect

> `const` **muiSelect**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiSelectProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiSelectProps) & [`MuiFormControlProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiFormControlProps)>


---

# Variable: muiSrRsComponentsDescriptions

> **muiSrRsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"Приказ података"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"Повратне информације"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"Облик"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"Улазни"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"Локација"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"Навигација"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"Површине"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"Ако је вредност Труе, тада се компонента проверава"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"Проверено"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"Садржај компоненте"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"Деца"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"Боја компоненте"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"Боја"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"Подразумевана вредност. Користи се када се компонентом не управља"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"Подразумевана вредност"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"Ако је вредност Труе, вертикално попуњавање се смањује"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"Густ"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"Ако је вредност Труе, тада је компонента онемогућена"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"Неспособан за рад"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"Ако је вредност Труе, онемогућава се леви и десни додатак"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"Искључите олуке"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"Ако је тачно, онемогућава подразумевано попуњавање"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"Онемогући пуњење"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"Ако је вредност Труе, компонента се приказује у стању грешке"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"Грешка"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"Ако је вредност Труе, компонента заузима целу ширину свог контејнера"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"Пуна ширина"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"Ако је вредност Труе, онда ће текст имати доњу маргину"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"Дно олука"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"Помоћни текстуални садржај"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"Помоћни текст"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"Дефинише поље примењено на компоненту"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"Профит"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"Ако је вредност Труе, текст се неће премотати, већ ће бити скраћен елипсом са преливањем текста"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"Без омота"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"Повратни позив се активира када се вредност промени"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"На промени"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"Повратни позив се покреће када кликнете на компоненту"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"Кликом миша"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"Ако је вредност Труе, тада је елемент који се уноси обавезан"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"Потребан"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"Величина компоненте"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"Величина"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"Системски реквизити који вам омогућавају да дефинишете системске замене, као и додатне ЦСС стилове"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"Поравнање текста"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"Поравнање"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"Вредност компоненте"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"Вредност"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"Опција за употребу"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"Опција"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"Универзални контејнер за распоред са подршком за системски стил"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"Кутија"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"Приказује тренутну локацију странице у хијерархији"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"Хлебне мрвице"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"Производи од презле за демонстрацију"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"Предмети"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"Ако је премашен максималан број ставки, број ставки приказаних након елипсе"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"Елементи након пресавијања"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"Ако је премашен максималан број ставки, тада је број ставки приказаних пре елипсе"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"Елементи пре пресавијања"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"Означава максималан број приказаних презли"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"Максималан број елемената"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"Елемент који се користи за одвајање презле"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"Разделник"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"Компонента дугмета која се користи за покретање радњи или догађаја"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"Дугме"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"Потпис"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"Садржај"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"Уклања сенку дугмета када се постави на Труе"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"Онемогући нивелисање"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"Приказује индикатор учитавања и искључује интеракцију"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"Утовар"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"Групише повезана дугмад заједно"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"Група дугмади"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"Омогућава групи дугмади да заузму целу ширину контејнера"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"Пуна ширина"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"Поставља смер распореда тастера"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"Оријентација"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"Површинска компонента за груписање повезаног садржаја"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"Мапа"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"Акциони тастери или контроле за мапу"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"Акције"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"Садржај приказан у наслову картице"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"Наслов"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"Елемент акције приказан у наслову"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"Акција наслова"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"Елемент аватара приказан у наслову"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"Аватар наслова"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"Мултимедијални садржај као што је слика или видео"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"Медији"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"Повратни позив се активира када одаберете картицу"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"Приликом избора"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"Додатни текст приказан испод наслова"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"Поднаслов"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"Приказује одељак са радњама на дну екрана"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"Користите акције"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"Омотајте садржај око интерактивног подручја деловања"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"Користите опсег мапе"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"Укључује одељак заглавља картице"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"Користите наслов"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"Укључује опсег унутар заглавља"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"Користите акцију заглавља"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"Приказује аватар унутар наслова"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"Користите аватар наслова"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"Укључује одељак за медије унутар меморијске картице"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"Користите медије"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"Приказује поднаслов испод главног наслова"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"Користите поднаслов"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"Омогућава вам да одаберете једну или више опција"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"Поље за потврду"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"Почетно стање које се проверава са неконтролисаним"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"Означено подразумевано поље за потврду"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"Означава учитавање или напредак у облику круга"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"Циклични напредак"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"Онемогућава анимацију компресије"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"Онемогући компресију"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"Контролише ширину потеза круга"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"Дебљина"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"Центрира и ограничава садржај хоризонтално"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"Контејнер"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"Поставља фиксну максималну ширину уместо глатке"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"Поправљено"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"Одређује максималну ширину контејнера"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"Максимална ширина"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"Омотава садржај и приказује стање грешке или поруку"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"Љуска грешке"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"Повезује ознаку са контролом обрасца"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"Контролна ознака обрасца"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"Контрола обрасца (поље за потврду, радио, прекидач)"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"Контрола"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"Положај ознаке у односу на контролу"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"Постављање етикета"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"Ознака за груписање или описивање поља обрасца"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"Ознака обрасца"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"Примењује стил попуњеног стања"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"Испуњен"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"Приказује учитавање или напредак у линеарној скали"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"Линеарни напредак"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"Вредност секундарног бафера за режим извођења са бафером"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"Бафер вредности"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"Интерактивни елемент за навигацију или радње"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"Линк"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"Крајњи УРЛ"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Линк"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"Приказује вертикалну листу ставки"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"Список"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"Представља посебан елемент унутар листе"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"Ставка листе"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"Приказује сепаратор испод ставке листе"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"Делилац"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"Омогућава вам да изаберете једну опцију из скупа"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"Радио Група"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"Атрибут Наме који се користи за груписање прекидача"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"Име"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"Приказује прекидаче хоризонтално"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"Ред"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"Један прекидач који се користи у групи радио станица"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"Радио пријемник"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"Падајућа компонента за одабир опција"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"Изаберите"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"Аутоматски фокусира поље на монтажу"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"Аутоматско фокусирање"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"Омогућава вам да одаберете више опција"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"Вишеструки"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"Компонује подређене елементе у једнодимензионалном стеку"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"Стек"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"Контролише поравнање попречне осе"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"Поравнање елемената"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"Одређује да ли ће се ставке налазити у реду или колони"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"Правац"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"Управља премотавањем елемената у више редова"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"Флексибилни омот"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"Контролише поравнање главне осе"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"Образложите садржај"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"Размак између наслаганих предмета"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"Удаљеност"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"Користи ЦСС размак уместо поља за размаке"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"Користите флексибилан размак"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"Контрола прекидача за пребацивање између два стања"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"Прекидач"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"Почетно стање пребацивања са неконтролисаним"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"Означено подразумевано поље за потврду"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"Поље за унос текста и података обрасца"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"Текстуално поље"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"Аутоматски фокусира поље на монтажу"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"Аутоматско фокусирање"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"Максималан број видљивих редова за вишередни унос"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"Максималан број редова"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"Приказује текстуално подручје уместо једнослојног уноса"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"Вишередни"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"Тип уноса хтмл (текст, лозинка, адреса е - поште итд.)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"Тип"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"Приказује контекстуалне информације приликом преласка мишем, фокусирања или додиривања"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"Савет"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"Приказује стрелицу која показује на циљни елемент"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"Стрела"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"Спречава да се описи алата појаве у фокусу"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"Онемогућите слушалац фокуса"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"Спречава да се појави опис када задржите показивач миша"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"Онемогућите преслушавач миша"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"Онемогућава интеракцију са садржајем описа"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"Онемогућите интерактивну интеракцију"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"Спречава да се појави Опис Када додирнете"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"Онемогућите слушалац осетљив на додир"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"Кашњење у милисекундама пре приказивања описа"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"Кашњење уноса"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"Присиљава опис да прати положај курсора"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"Пратите курсор"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"Кашњење у милисекундама пре скривања описа"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"Одлагање одмора"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"Текстуални садржај приказан у опису"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"Наслов"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"Приказује текст са унапред дефинисаним типографским стиловима"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"Типографија"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"Текстуални садржај"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"Садржај"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"Компонента за преузимање једне или више датотека"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"Утоваривач"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"Дозвољени типови датотека (нпр.jpg,.png\")"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"Прихвати"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"Омогућава вам да одаберете више датотека"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"Вишеструки"`


---

# Variable: muiStack

> `const` **muiStack**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`Omit`<[`MuiStackProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiStackProps), `"ref"`> & `RefAttributes`<`HTMLDivElement`>>


---

# Variable: muiSwitch

> `const` **muiSwitch**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiSwitchProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/interfaces/MuiSwitchProps)>


---

# Variable: muiTextField

> `const` **muiTextField**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`MuiTextFieldProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-material-ui/type-aliases/MuiTextFieldProps)>


---

# Variable: muiTooltip

> `const` **muiTooltip**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`TooltipProps`>


---

# Variable: muiTypography

> `const` **muiTypography**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`DefaultComponentProps`<`TypographyTypeMap`<{ }, `"span"`>>>


---

# Variable: muiUploader

> `const` **muiUploader**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`object`>


---

# Variable: MuiViewerWrapper

> `const` **MuiViewerWrapper**: [`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)

Provides the MUI theme.

## Param[​](#param "Direct link to Param")

the FormViewerWrapper props.

## Returns[​](#returns "Direct link to Returns")

the React context provider.


---

# Variable: muiZhCnComponentsDescriptions

> **muiZhCnComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.dataDisplay[​](#categoriesdatadisplay "Direct link to categories.dataDisplay")

> **categories.dataDisplay**: `object`

#### categories.dataDisplay.name[​](#categoriesdatadisplayname "Direct link to categories.dataDisplay.name")

> **categories.dataDisplay.name**: `string` = `"数据显示"`

#### categories.feedback[​](#categoriesfeedback "Direct link to categories.feedback")

> **categories.feedback**: `object`

#### categories.feedback.name[​](#categoriesfeedbackname "Direct link to categories.feedback.name")

> **categories.feedback.name**: `string` = `"反馈意见"`

#### categories.form[​](#categoriesform "Direct link to categories.form")

> **categories.form**: `object`

#### categories.form.name[​](#categoriesformname "Direct link to categories.form.name")

> **categories.form.name**: `string` = `"表格"`

#### categories.inputs[​](#categoriesinputs "Direct link to categories.inputs")

> **categories.inputs**: `object`

#### categories.inputs.name[​](#categoriesinputsname "Direct link to categories.inputs.name")

> **categories.inputs.name**: `string` = `"输入"`

#### categories.layout[​](#categorieslayout "Direct link to categories.layout")

> **categories.layout**: `object`

#### categories.layout.name[​](#categorieslayoutname "Direct link to categories.layout.name")

> **categories.layout.name**: `string` = `"设计图"`

#### categories.navigation[​](#categoriesnavigation "Direct link to categories.navigation")

> **categories.navigation**: `object`

#### categories.navigation.name[​](#categoriesnavigationname "Direct link to categories.navigation.name")

> **categories.navigation.name**: `string` = `"导航"`

#### categories.surfaces[​](#categoriessurfaces "Direct link to categories.surfaces")

> **categories.surfaces**: `object`

#### categories.surfaces.name[​](#categoriessurfacesname "Direct link to categories.surfaces.name")

> **categories.surfaces.name**: `string` = `"表面"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.checked[​](#commonpropertieschecked "Direct link to commonProperties.checked")

> **commonProperties.checked**: `object`

#### commonProperties.checked.description[​](#commonpropertiescheckeddescription "Direct link to commonProperties.checked.description")

> **commonProperties.checked.description**: `string` = `"如果为true，则检查组件"`

#### commonProperties.checked.name[​](#commonpropertiescheckedname "Direct link to commonProperties.checked.name")

> **commonProperties.checked.name**: `string` = `"检查过"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"组件的内容"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"儿童"`

#### commonProperties.color[​](#commonpropertiescolor "Direct link to commonProperties.color")

> **commonProperties.color**: `object`

#### commonProperties.color.description[​](#commonpropertiescolordescription "Direct link to commonProperties.color.description")

> **commonProperties.color.description**: `string` = `"组件的颜色"`

#### commonProperties.color.name[​](#commonpropertiescolorname "Direct link to commonProperties.color.name")

> **commonProperties.color.name**: `string` = `"颜色"`

#### commonProperties.defaultValue[​](#commonpropertiesdefaultvalue "Direct link to commonProperties.defaultValue")

> **commonProperties.defaultValue**: `object`

#### commonProperties.defaultValue.description[​](#commonpropertiesdefaultvaluedescription "Direct link to commonProperties.defaultValue.description")

> **commonProperties.defaultValue.description**: `string` = `"默认值。 组件未受控时使用"`

#### commonProperties.defaultValue.name[​](#commonpropertiesdefaultvaluename "Direct link to commonProperties.defaultValue.name")

> **commonProperties.defaultValue.name**: `string` = `"默认值"`

#### commonProperties.dense[​](#commonpropertiesdense "Direct link to commonProperties.dense")

> **commonProperties.dense**: `object`

#### commonProperties.dense.description[​](#commonpropertiesdensedescription "Direct link to commonProperties.dense.description")

> **commonProperties.dense.description**: `string` = `"如果为true，则减少垂直填充"`

#### commonProperties.dense.name[​](#commonpropertiesdensename "Direct link to commonProperties.dense.name")

> **commonProperties.dense.name**: `string` = `"密密麻麻"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"如果为true，则禁用该组件"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"残疾人士"`

#### commonProperties.disableGutters[​](#commonpropertiesdisablegutters "Direct link to commonProperties.disableGutters")

> **commonProperties.disableGutters**: `object`

#### commonProperties.disableGutters.description[​](#commonpropertiesdisableguttersdescription "Direct link to commonProperties.disableGutters.description")

> **commonProperties.disableGutters.description**: `string` = `"如果为true，则禁用左右填充"`

#### commonProperties.disableGutters.name[​](#commonpropertiesdisableguttersname "Direct link to commonProperties.disableGutters.name")

> **commonProperties.disableGutters.name**: `string` = `"禁用水槽"`

#### commonProperties.disablePadding[​](#commonpropertiesdisablepadding "Direct link to commonProperties.disablePadding")

> **commonProperties.disablePadding**: `object`

#### commonProperties.disablePadding.description[​](#commonpropertiesdisablepaddingdescription "Direct link to commonProperties.disablePadding.description")

> **commonProperties.disablePadding.description**: `string` = `"如果为true，则禁用默认填充"`

#### commonProperties.disablePadding.name[​](#commonpropertiesdisablepaddingname "Direct link to commonProperties.disablePadding.name")

> **commonProperties.disablePadding.name**: `string` = `"禁用填充"`

#### commonProperties.error[​](#commonpropertieserror "Direct link to commonProperties.error")

> **commonProperties.error**: `object`

#### commonProperties.error.description[​](#commonpropertieserrordescription "Direct link to commonProperties.error.description")

> **commonProperties.error.description**: `string` = `"如果为true，则组件显示为错误状态"`

#### commonProperties.error.name[​](#commonpropertieserrorname "Direct link to commonProperties.error.name")

> **commonProperties.error.name**: `string` = `"错误"`

#### commonProperties.fullWidth[​](#commonpropertiesfullwidth "Direct link to commonProperties.fullWidth")

> **commonProperties.fullWidth**: `object`

#### commonProperties.fullWidth.description[​](#commonpropertiesfullwidthdescription "Direct link to commonProperties.fullWidth.description")

> **commonProperties.fullWidth.description**: `string` = `"如果为true，则组件占用其容器的全宽"`

#### commonProperties.fullWidth.name[​](#commonpropertiesfullwidthname "Direct link to commonProperties.fullWidth.name")

> **commonProperties.fullWidth.name**: `string` = `"全幅"`

#### commonProperties.gutterBottom[​](#commonpropertiesgutterbottom "Direct link to commonProperties.gutterBottom")

> **commonProperties.gutterBottom**: `object`

#### commonProperties.gutterBottom.description[​](#commonpropertiesgutterbottomdescription "Direct link to commonProperties.gutterBottom.description")

> **commonProperties.gutterBottom.description**: `string` = `"如果为true，则文本将具有底边距"`

#### commonProperties.gutterBottom.name[​](#commonpropertiesgutterbottomname "Direct link to commonProperties.gutterBottom.name")

> **commonProperties.gutterBottom.name**: `string` = `"排水沟底部"`

#### commonProperties.helperText[​](#commonpropertieshelpertext "Direct link to commonProperties.helperText")

> **commonProperties.helperText**: `object`

#### commonProperties.helperText.description[​](#commonpropertieshelpertextdescription "Direct link to commonProperties.helperText.description")

> **commonProperties.helperText.description**: `string` = `"辅助文本内容"`

#### commonProperties.helperText.name[​](#commonpropertieshelpertextname "Direct link to commonProperties.helperText.name")

> **commonProperties.helperText.name**: `string` = `"辅助文本"`

#### commonProperties.margin[​](#commonpropertiesmargin "Direct link to commonProperties.margin")

> **commonProperties.margin**: `object`

#### commonProperties.margin.description[​](#commonpropertiesmargindescription "Direct link to commonProperties.margin.description")

> **commonProperties.margin.description**: `string` = `"定义应用于组件的边距"`

#### commonProperties.margin.name[​](#commonpropertiesmarginname "Direct link to commonProperties.margin.name")

> **commonProperties.margin.name**: `string` = `"保证金"`

#### commonProperties.noWrap[​](#commonpropertiesnowrap "Direct link to commonProperties.noWrap")

> **commonProperties.noWrap**: `object`

#### commonProperties.noWrap.description[​](#commonpropertiesnowrapdescription "Direct link to commonProperties.noWrap.description")

> **commonProperties.noWrap.description**: `string` = `"如果为true，则文本不会换行，而是使用文本溢出省略号截断"`

#### commonProperties.noWrap.name[​](#commonpropertiesnowrapname "Direct link to commonProperties.noWrap.name")

> **commonProperties.noWrap.name**: `string` = `"没有包装"`

#### commonProperties.onChange[​](#commonpropertiesonchange "Direct link to commonProperties.onChange")

> **commonProperties.onChange**: `object`

#### commonProperties.onChange.description[​](#commonpropertiesonchangedescription "Direct link to commonProperties.onChange.description")

> **commonProperties.onChange.description**: `string` = `"值更改时触发回调"`

#### commonProperties.onChange.name[​](#commonpropertiesonchangename "Direct link to commonProperties.onChange.name")

> **commonProperties.onChange.name**: `string` = `"交换/交换"`

#### commonProperties.onClick[​](#commonpropertiesonclick "Direct link to commonProperties.onClick")

> **commonProperties.onClick**: `object`

#### commonProperties.onClick.description[​](#commonpropertiesonclickdescription "Direct link to commonProperties.onClick.description")

> **commonProperties.onClick.description**: `string` = `"单击组件时触发的回调"`

#### commonProperties.onClick.name[​](#commonpropertiesonclickname "Direct link to commonProperties.onClick.name")

> **commonProperties.onClick.name**: `string` = `"昂克里克"`

#### commonProperties.required[​](#commonpropertiesrequired "Direct link to commonProperties.required")

> **commonProperties.required**: `object`

#### commonProperties.required.description[​](#commonpropertiesrequireddescription "Direct link to commonProperties.required.description")

> **commonProperties.required.description**: `string` = `"如果为true，则需要输入元素"`

#### commonProperties.required.name[​](#commonpropertiesrequiredname "Direct link to commonProperties.required.name")

> **commonProperties.required.name**: `string` = `"需要"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"组件的大小"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"大小"`

#### commonProperties.sx[​](#commonpropertiessx "Direct link to commonProperties.sx")

> **commonProperties.sx**: `object`

#### commonProperties.sx.description[​](#commonpropertiessxdescription "Direct link to commonProperties.sx.description")

> **commonProperties.sx.description**: `string` = `"允许定义系统复盖以及附加CSS样式的系统道具"`

#### commonProperties.sx.name[​](#commonpropertiessxname "Direct link to commonProperties.sx.name")

> **commonProperties.sx.name**: `string` = `"Sx"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"文本对齐方式"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"对齐方式"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"组件的值"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"价值"`

#### commonProperties.variant[​](#commonpropertiesvariant "Direct link to commonProperties.variant")

> **commonProperties.variant**: `object`

#### commonProperties.variant.description[​](#commonpropertiesvariantdescription "Direct link to commonProperties.variant.description")

> **commonProperties.variant.description**: `string` = `"要使用的变体"`

#### commonProperties.variant.name[​](#commonpropertiesvariantname "Direct link to commonProperties.variant.name")

> **commonProperties.variant.name**: `string` = `"变式"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.MuiBox[​](#componentsmuibox "Direct link to components.MuiBox")

> **components.MuiBox**: `object`

#### components.MuiBox.description[​](#componentsmuiboxdescription "Direct link to components.MuiBox.description")

> **components.MuiBox.description**: `string` = `"具有系统样式支持的通用布局容器"`

#### components.MuiBox.name[​](#componentsmuiboxname "Direct link to components.MuiBox.name")

> **components.MuiBox.name**: `string` = `"盒子"`

#### components.MuiBreadcrumbs[​](#componentsmuibreadcrumbs "Direct link to components.MuiBreadcrumbs")

> **components.MuiBreadcrumbs**: `object`

#### components.MuiBreadcrumbs.description[​](#componentsmuibreadcrumbsdescription "Direct link to components.MuiBreadcrumbs.description")

> **components.MuiBreadcrumbs.description**: `string` = `"显示层次结构中的当前页面位置"`

#### components.MuiBreadcrumbs.name[​](#componentsmuibreadcrumbsname "Direct link to components.MuiBreadcrumbs.name")

> **components.MuiBreadcrumbs.name**: `string` = `"[医]面包屑"`

#### components.MuiBreadcrumbs.props[​](#componentsmuibreadcrumbsprops "Direct link to components.MuiBreadcrumbs.props")

> **components.MuiBreadcrumbs.props**: `object`

#### components.MuiBreadcrumbs.props.items[​](#componentsmuibreadcrumbspropsitems "Direct link to components.MuiBreadcrumbs.props.items")

> **components.MuiBreadcrumbs.props.items**: `object`

#### components.MuiBreadcrumbs.props.items.description[​](#componentsmuibreadcrumbspropsitemsdescription "Direct link to components.MuiBreadcrumbs.props.items.description")

> **components.MuiBreadcrumbs.props.items.description**: `string` = `"要显示的面包屑项目"`

#### components.MuiBreadcrumbs.props.items.name[​](#componentsmuibreadcrumbspropsitemsname "Direct link to components.MuiBreadcrumbs.props.items.name")

> **components.MuiBreadcrumbs.props.items.name**: `string` = `"项目"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse[​](#componentsmuibreadcrumbspropsitemsaftercollapse "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.description[​](#componentsmuibreadcrumbspropsitemsaftercollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.description")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.description**: `string` = `"如果超过最大项数，则省略号后显示的项数"`

#### components.MuiBreadcrumbs.props.itemsAfterCollapse.name[​](#componentsmuibreadcrumbspropsitemsaftercollapsename "Direct link to components.MuiBreadcrumbs.props.itemsAfterCollapse.name")

> **components.MuiBreadcrumbs.props.itemsAfterCollapse.name**: `string` = `"崩溃后的项目"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse[​](#componentsmuibreadcrumbspropsitemsbeforecollapse "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse**: `object`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.description[​](#componentsmuibreadcrumbspropsitemsbeforecollapsedescription "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.description")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.description**: `string` = `"如果超过最大项数，则省略号前显示的项数"`

#### components.MuiBreadcrumbs.props.itemsBeforeCollapse.name[​](#componentsmuibreadcrumbspropsitemsbeforecollapsename "Direct link to components.MuiBreadcrumbs.props.itemsBeforeCollapse.name")

> **components.MuiBreadcrumbs.props.itemsBeforeCollapse.name**: `string` = `"折叠前的项目"`

#### components.MuiBreadcrumbs.props.maxItems[​](#componentsmuibreadcrumbspropsmaxitems "Direct link to components.MuiBreadcrumbs.props.maxItems")

> **components.MuiBreadcrumbs.props.maxItems**: `object`

#### components.MuiBreadcrumbs.props.maxItems.description[​](#componentsmuibreadcrumbspropsmaxitemsdescription "Direct link to components.MuiBreadcrumbs.props.maxItems.description")

> **components.MuiBreadcrumbs.props.maxItems.description**: `string` = `"指定要显示的面包屑的最大数量"`

#### components.MuiBreadcrumbs.props.maxItems.name[​](#componentsmuibreadcrumbspropsmaxitemsname "Direct link to components.MuiBreadcrumbs.props.maxItems.name")

> **components.MuiBreadcrumbs.props.maxItems.name**: `string` = `"最大项目"`

#### components.MuiBreadcrumbs.props.separator[​](#componentsmuibreadcrumbspropsseparator "Direct link to components.MuiBreadcrumbs.props.separator")

> **components.MuiBreadcrumbs.props.separator**: `object`

#### components.MuiBreadcrumbs.props.separator.description[​](#componentsmuibreadcrumbspropsseparatordescription "Direct link to components.MuiBreadcrumbs.props.separator.description")

> **components.MuiBreadcrumbs.props.separator.description**: `string` = `"用于分离面包屑项的元素"`

#### components.MuiBreadcrumbs.props.separator.name[​](#componentsmuibreadcrumbspropsseparatorname "Direct link to components.MuiBreadcrumbs.props.separator.name")

> **components.MuiBreadcrumbs.props.separator.name**: `string` = `"分离器"`

#### components.MuiButton[​](#componentsmuibutton "Direct link to components.MuiButton")

> **components.MuiButton**: `object`

#### components.MuiButton.description[​](#componentsmuibuttondescription "Direct link to components.MuiButton.description")

> **components.MuiButton.description**: `string` = `"用于触发动作或事件的按钮组件"`

#### components.MuiButton.name[​](#componentsmuibuttonname "Direct link to components.MuiButton.name")

> **components.MuiButton.name**: `string` = `"按钮"`

#### components.MuiButton.props[​](#componentsmuibuttonprops "Direct link to components.MuiButton.props")

> **components.MuiButton.props**: `object`

#### components.MuiButton.props.children[​](#componentsmuibuttonpropschildren "Direct link to components.MuiButton.props.children")

> **components.MuiButton.props.children**: `object`

#### components.MuiButton.props.children.description[​](#componentsmuibuttonpropschildrendescription "Direct link to components.MuiButton.props.children.description")

> **components.MuiButton.props.children.description**: `string` = `"标题"`

#### components.MuiButton.props.children.name[​](#componentsmuibuttonpropschildrenname "Direct link to components.MuiButton.props.children.name")

> **components.MuiButton.props.children.name**: `string` = `"内容"`

#### components.MuiButton.props.disableElevation[​](#componentsmuibuttonpropsdisableelevation "Direct link to components.MuiButton.props.disableElevation")

> **components.MuiButton.props.disableElevation**: `object`

#### components.MuiButton.props.disableElevation.description[​](#componentsmuibuttonpropsdisableelevationdescription "Direct link to components.MuiButton.props.disableElevation.description")

> **components.MuiButton.props.disableElevation.description**: `string` = `"设置为true时删除按钮阴影"`

#### components.MuiButton.props.disableElevation.name[​](#componentsmuibuttonpropsdisableelevationname "Direct link to components.MuiButton.props.disableElevation.name")

> **components.MuiButton.props.disableElevation.name**: `string` = `"禁用高程"`

#### components.MuiButton.props.loading[​](#componentsmuibuttonpropsloading "Direct link to components.MuiButton.props.loading")

> **components.MuiButton.props.loading**: `object`

#### components.MuiButton.props.loading.description[​](#componentsmuibuttonpropsloadingdescription "Direct link to components.MuiButton.props.loading.description")

> **components.MuiButton.props.loading.description**: `string` = `"显示加载指示器并禁用交互"`

#### components.MuiButton.props.loading.name[​](#componentsmuibuttonpropsloadingname "Direct link to components.MuiButton.props.loading.name")

> **components.MuiButton.props.loading.name**: `string` = `"装载量"`

#### components.MuiButtonGroup[​](#componentsmuibuttongroup "Direct link to components.MuiButtonGroup")

> **components.MuiButtonGroup**: `object`

#### components.MuiButtonGroup.description[​](#componentsmuibuttongroupdescription "Direct link to components.MuiButtonGroup.description")

> **components.MuiButtonGroup.description**: `string` = `"将相关按钮分组在一起"`

#### components.MuiButtonGroup.name[​](#componentsmuibuttongroupname "Direct link to components.MuiButtonGroup.name")

> **components.MuiButtonGroup.name**: `string` = `"按钮组"`

#### components.MuiButtonGroup.props[​](#componentsmuibuttongroupprops "Direct link to components.MuiButtonGroup.props")

> **components.MuiButtonGroup.props**: `object`

#### components.MuiButtonGroup.props.fullWidth[​](#componentsmuibuttongrouppropsfullwidth "Direct link to components.MuiButtonGroup.props.fullWidth")

> **components.MuiButtonGroup.props.fullWidth**: `object`

#### components.MuiButtonGroup.props.fullWidth.description[​](#componentsmuibuttongrouppropsfullwidthdescription "Direct link to components.MuiButtonGroup.props.fullWidth.description")

> **components.MuiButtonGroup.props.fullWidth.description**: `string` = `"使按钮组跨越整个容器宽度"`

#### components.MuiButtonGroup.props.fullWidth.name[​](#componentsmuibuttongrouppropsfullwidthname "Direct link to components.MuiButtonGroup.props.fullWidth.name")

> **components.MuiButtonGroup.props.fullWidth.name**: `string` = `"全幅"`

#### components.MuiButtonGroup.props.orientation[​](#componentsmuibuttongrouppropsorientation "Direct link to components.MuiButtonGroup.props.orientation")

> **components.MuiButtonGroup.props.orientation**: `object`

#### components.MuiButtonGroup.props.orientation.description[​](#componentsmuibuttongrouppropsorientationdescription "Direct link to components.MuiButtonGroup.props.orientation.description")

> **components.MuiButtonGroup.props.orientation.description**: `string` = `"设置按钮的布局方向"`

#### components.MuiButtonGroup.props.orientation.name[​](#componentsmuibuttongrouppropsorientationname "Direct link to components.MuiButtonGroup.props.orientation.name")

> **components.MuiButtonGroup.props.orientation.name**: `string` = `"方向感"`

#### components.MuiCard[​](#componentsmuicard "Direct link to components.MuiCard")

> **components.MuiCard**: `object`

#### components.MuiCard.description[​](#componentsmuicarddescription "Direct link to components.MuiCard.description")

> **components.MuiCard.description**: `string` = `"用于分组相关内容的表面组件"`

#### components.MuiCard.name[​](#componentsmuicardname "Direct link to components.MuiCard.name")

> **components.MuiCard.name**: `string` = `"卡片"`

#### components.MuiCard.props[​](#componentsmuicardprops "Direct link to components.MuiCard.props")

> **components.MuiCard.props**: `object`

#### components.MuiCard.props.actions[​](#componentsmuicardpropsactions "Direct link to components.MuiCard.props.actions")

> **components.MuiCard.props.actions**: `object`

#### components.MuiCard.props.actions.description[​](#componentsmuicardpropsactionsdescription "Direct link to components.MuiCard.props.actions.description")

> **components.MuiCard.props.actions.description**: `string` = `"卡的操作按钮或控件"`

#### components.MuiCard.props.actions.name[​](#componentsmuicardpropsactionsname "Direct link to components.MuiCard.props.actions.name")

> **components.MuiCard.props.actions.name**: `string` = `"行动"`

#### components.MuiCard.props.header[​](#componentsmuicardpropsheader "Direct link to components.MuiCard.props.header")

> **components.MuiCard.props.header**: `object`

#### components.MuiCard.props.header.description[​](#componentsmuicardpropsheaderdescription "Direct link to components.MuiCard.props.header.description")

> **components.MuiCard.props.header.description**: `string` = `"卡头中呈现的内容"`

#### components.MuiCard.props.header.name[​](#componentsmuicardpropsheadername "Direct link to components.MuiCard.props.header.name")

> **components.MuiCard.props.header.name**: `string` = `"标题"`

#### components.MuiCard.props.headerAction[​](#componentsmuicardpropsheaderaction "Direct link to components.MuiCard.props.headerAction")

> **components.MuiCard.props.headerAction**: `object`

#### components.MuiCard.props.headerAction.description[​](#componentsmuicardpropsheaderactiondescription "Direct link to components.MuiCard.props.headerAction.description")

> **components.MuiCard.props.headerAction.description**: `string` = `"标题中显示的操作元素"`

#### components.MuiCard.props.headerAction.name[​](#componentsmuicardpropsheaderactionname "Direct link to components.MuiCard.props.headerAction.name")

> **components.MuiCard.props.headerAction.name**: `string` = `"标题操作"`

#### components.MuiCard.props.headerAvatar[​](#componentsmuicardpropsheaderavatar "Direct link to components.MuiCard.props.headerAvatar")

> **components.MuiCard.props.headerAvatar**: `object`

#### components.MuiCard.props.headerAvatar.description[​](#componentsmuicardpropsheaderavatardescription "Direct link to components.MuiCard.props.headerAvatar.description")

> **components.MuiCard.props.headerAvatar.description**: `string` = `"标题中显示的头像元素"`

#### components.MuiCard.props.headerAvatar.name[​](#componentsmuicardpropsheaderavatarname "Direct link to components.MuiCard.props.headerAvatar.name")

> **components.MuiCard.props.headerAvatar.name**: `string` = `"头部头像"`

#### components.MuiCard.props.media[​](#componentsmuicardpropsmedia "Direct link to components.MuiCard.props.media")

> **components.MuiCard.props.media**: `object`

#### components.MuiCard.props.media.description[​](#componentsmuicardpropsmediadescription "Direct link to components.MuiCard.props.media.description")

> **components.MuiCard.props.media.description**: `string` = `"媒体内容，如图像或视频"`

#### components.MuiCard.props.media.name[​](#componentsmuicardpropsmedianame "Direct link to components.MuiCard.props.media.name")

> **components.MuiCard.props.media.name**: `string` = `"媒体报道"`

#### components.MuiCard.props.onSelect[​](#componentsmuicardpropsonselect "Direct link to components.MuiCard.props.onSelect")

> **components.MuiCard.props.onSelect**: `object`

#### components.MuiCard.props.onSelect.description[​](#componentsmuicardpropsonselectdescription "Direct link to components.MuiCard.props.onSelect.description")

> **components.MuiCard.props.onSelect.description**: `string` = `"选择卡时触发的回调"`

#### components.MuiCard.props.onSelect.name[​](#componentsmuicardpropsonselectname "Direct link to components.MuiCard.props.onSelect.name")

> **components.MuiCard.props.onSelect.name**: `string` = `"选择,选择"`

#### components.MuiCard.props.subHeader[​](#componentsmuicardpropssubheader "Direct link to components.MuiCard.props.subHeader")

> **components.MuiCard.props.subHeader**: `object`

#### components.MuiCard.props.subHeader.description[​](#componentsmuicardpropssubheaderdescription "Direct link to components.MuiCard.props.subHeader.description")

> **components.MuiCard.props.subHeader.description**: `string` = `"标题下方显示的辅助文本"`

#### components.MuiCard.props.subHeader.name[​](#componentsmuicardpropssubheadername "Direct link to components.MuiCard.props.subHeader.name")

> **components.MuiCard.props.subHeader.name**: `string` = `"子标题"`

#### components.MuiCard.props.useActions[​](#componentsmuicardpropsuseactions "Direct link to components.MuiCard.props.useActions")

> **components.MuiCard.props.useActions**: `object`

#### components.MuiCard.props.useActions.description[​](#componentsmuicardpropsuseactionsdescription "Direct link to components.MuiCard.props.useActions.description")

> **components.MuiCard.props.useActions.description**: `string` = `"在底部显示操作部分"`

#### components.MuiCard.props.useActions.name[​](#componentsmuicardpropsuseactionsname "Direct link to components.MuiCard.props.useActions.name")

> **components.MuiCard.props.useActions.name**: `string` = `"使用操作"`

#### components.MuiCard.props.useCardActionArea[​](#componentsmuicardpropsusecardactionarea "Direct link to components.MuiCard.props.useCardActionArea")

> **components.MuiCard.props.useCardActionArea**: `object`

#### components.MuiCard.props.useCardActionArea.description[​](#componentsmuicardpropsusecardactionareadescription "Direct link to components.MuiCard.props.useCardActionArea.description")

> **components.MuiCard.props.useCardActionArea.description**: `string` = `"使用可点击的操作区域包装内容"`

#### components.MuiCard.props.useCardActionArea.name[​](#componentsmuicardpropsusecardactionareaname "Direct link to components.MuiCard.props.useCardActionArea.name")

> **components.MuiCard.props.useCardActionArea.name**: `string` = `"使用卡片动作区"`

#### components.MuiCard.props.useHeader[​](#componentsmuicardpropsuseheader "Direct link to components.MuiCard.props.useHeader")

> **components.MuiCard.props.useHeader**: `object`

#### components.MuiCard.props.useHeader.description[​](#componentsmuicardpropsuseheaderdescription "Direct link to components.MuiCard.props.useHeader.description")

> **components.MuiCard.props.useHeader.description**: `string` = `"启用卡头部分"`

#### components.MuiCard.props.useHeader.name[​](#componentsmuicardpropsuseheadername "Direct link to components.MuiCard.props.useHeader.name")

> **components.MuiCard.props.useHeader.name**: `string` = `"使用标头"`

#### components.MuiCard.props.useHeaderAction[​](#componentsmuicardpropsuseheaderaction "Direct link to components.MuiCard.props.useHeaderAction")

> **components.MuiCard.props.useHeaderAction**: `object`

#### components.MuiCard.props.useHeaderAction.description[​](#componentsmuicardpropsuseheaderactiondescription "Direct link to components.MuiCard.props.useHeaderAction.description")

> **components.MuiCard.props.useHeaderAction.description**: `string` = `"启用标题内的操作区域"`

#### components.MuiCard.props.useHeaderAction.name[​](#componentsmuicardpropsuseheaderactionname "Direct link to components.MuiCard.props.useHeaderAction.name")

> **components.MuiCard.props.useHeaderAction.name**: `string` = `"使用标题操作"`

#### components.MuiCard.props.useHeaderAvatar[​](#componentsmuicardpropsuseheaderavatar "Direct link to components.MuiCard.props.useHeaderAvatar")

> **components.MuiCard.props.useHeaderAvatar**: `object`

#### components.MuiCard.props.useHeaderAvatar.description[​](#componentsmuicardpropsuseheaderavatardescription "Direct link to components.MuiCard.props.useHeaderAvatar.description")

> **components.MuiCard.props.useHeaderAvatar.description**: `string` = `"在标题内显示头像"`

#### components.MuiCard.props.useHeaderAvatar.name[​](#componentsmuicardpropsuseheaderavatarname "Direct link to components.MuiCard.props.useHeaderAvatar.name")

> **components.MuiCard.props.useHeaderAvatar.name**: `string` = `"使用标题头像"`

#### components.MuiCard.props.useMedia[​](#componentsmuicardpropsusemedia "Direct link to components.MuiCard.props.useMedia")

> **components.MuiCard.props.useMedia**: `object`

#### components.MuiCard.props.useMedia.description[​](#componentsmuicardpropsusemediadescription "Direct link to components.MuiCard.props.useMedia.description")

> **components.MuiCard.props.useMedia.description**: `string` = `"启用卡内的媒体部分"`

#### components.MuiCard.props.useMedia.name[​](#componentsmuicardpropsusemedianame "Direct link to components.MuiCard.props.useMedia.name")

> **components.MuiCard.props.useMedia.name**: `string` = `"使用媒体"`

#### components.MuiCard.props.useSubheader[​](#componentsmuicardpropsusesubheader "Direct link to components.MuiCard.props.useSubheader")

> **components.MuiCard.props.useSubheader**: `object`

#### components.MuiCard.props.useSubheader.description[​](#componentsmuicardpropsusesubheaderdescription "Direct link to components.MuiCard.props.useSubheader.description")

> **components.MuiCard.props.useSubheader.description**: `string` = `"在主标题下方显示子标题"`

#### components.MuiCard.props.useSubheader.name[​](#componentsmuicardpropsusesubheadername "Direct link to components.MuiCard.props.useSubheader.name")

> **components.MuiCard.props.useSubheader.name**: `string` = `"使用子标题"`

#### components.MuiCheckbox[​](#componentsmuicheckbox "Direct link to components.MuiCheckbox")

> **components.MuiCheckbox**: `object`

#### components.MuiCheckbox.description[​](#componentsmuicheckboxdescription "Direct link to components.MuiCheckbox.description")

> **components.MuiCheckbox.description**: `string` = `"允许选择一个或多个选项"`

#### components.MuiCheckbox.name[​](#componentsmuicheckboxname "Direct link to components.MuiCheckbox.name")

> **components.MuiCheckbox.name**: `string` = `"复选框"`

#### components.MuiCheckbox.props[​](#componentsmuicheckboxprops "Direct link to components.MuiCheckbox.props")

> **components.MuiCheckbox.props**: `object`

#### components.MuiCheckbox.props.defaultChecked[​](#componentsmuicheckboxpropsdefaultchecked "Direct link to components.MuiCheckbox.props.defaultChecked")

> **components.MuiCheckbox.props.defaultChecked**: `object`

#### components.MuiCheckbox.props.defaultChecked.description[​](#componentsmuicheckboxpropsdefaultcheckeddescription "Direct link to components.MuiCheckbox.props.defaultChecked.description")

> **components.MuiCheckbox.props.defaultChecked.description**: `string` = `"不受控制时的初始检查状态"`

#### components.MuiCheckbox.props.defaultChecked.name[​](#componentsmuicheckboxpropsdefaultcheckedname "Direct link to components.MuiCheckbox.props.defaultChecked.name")

> **components.MuiCheckbox.props.defaultChecked.name**: `string` = `"默认检查"`

#### components.MuiCircularProgress[​](#componentsmuicircularprogress "Direct link to components.MuiCircularProgress")

> **components.MuiCircularProgress**: `object`

#### components.MuiCircularProgress.description[​](#componentsmuicircularprogressdescription "Direct link to components.MuiCircularProgress.description")

> **components.MuiCircularProgress.description**: `string` = `"以循环形式指示加载或进度"`

#### components.MuiCircularProgress.name[​](#componentsmuicircularprogressname "Direct link to components.MuiCircularProgress.name")

> **components.MuiCircularProgress.name**: `string` = `"循环进展"`

#### components.MuiCircularProgress.props[​](#componentsmuicircularprogressprops "Direct link to components.MuiCircularProgress.props")

> **components.MuiCircularProgress.props**: `object`

#### components.MuiCircularProgress.props.disableShrink[​](#componentsmuicircularprogresspropsdisableshrink "Direct link to components.MuiCircularProgress.props.disableShrink")

> **components.MuiCircularProgress.props.disableShrink**: `object`

#### components.MuiCircularProgress.props.disableShrink.description[​](#componentsmuicircularprogresspropsdisableshrinkdescription "Direct link to components.MuiCircularProgress.props.disableShrink.description")

> **components.MuiCircularProgress.props.disableShrink.description**: `string` = `"禁用收缩动画"`

#### components.MuiCircularProgress.props.disableShrink.name[​](#componentsmuicircularprogresspropsdisableshrinkname "Direct link to components.MuiCircularProgress.props.disableShrink.name")

> **components.MuiCircularProgress.props.disableShrink.name**: `string` = `"禁用收缩"`

#### components.MuiCircularProgress.props.thickness[​](#componentsmuicircularprogresspropsthickness "Direct link to components.MuiCircularProgress.props.thickness")

> **components.MuiCircularProgress.props.thickness**: `object`

#### components.MuiCircularProgress.props.thickness.description[​](#componentsmuicircularprogresspropsthicknessdescription "Direct link to components.MuiCircularProgress.props.thickness.description")

> **components.MuiCircularProgress.props.thickness.description**: `string` = `"控制圆的笔画宽度"`

#### components.MuiCircularProgress.props.thickness.name[​](#componentsmuicircularprogresspropsthicknessname "Direct link to components.MuiCircularProgress.props.thickness.name")

> **components.MuiCircularProgress.props.thickness.name**: `string` = `"厚度"`

#### components.MuiContainer[​](#componentsmuicontainer "Direct link to components.MuiContainer")

> **components.MuiContainer**: `object`

#### components.MuiContainer.description[​](#componentsmuicontainerdescription "Direct link to components.MuiContainer.description")

> **components.MuiContainer.description**: `string` = `"水平居中和约束内容"`

#### components.MuiContainer.name[​](#componentsmuicontainername "Direct link to components.MuiContainer.name")

> **components.MuiContainer.name**: `string` = `"货柜"`

#### components.MuiContainer.props[​](#componentsmuicontainerprops "Direct link to components.MuiContainer.props")

> **components.MuiContainer.props**: `object`

#### components.MuiContainer.props.fixed[​](#componentsmuicontainerpropsfixed "Direct link to components.MuiContainer.props.fixed")

> **components.MuiContainer.props.fixed**: `object`

#### components.MuiContainer.props.fixed.description[​](#componentsmuicontainerpropsfixeddescription "Direct link to components.MuiContainer.props.fixed.description")

> **components.MuiContainer.props.fixed.description**: `string` = `"设置固定的最大宽度而不是流体宽度"`

#### components.MuiContainer.props.fixed.name[​](#componentsmuicontainerpropsfixedname "Direct link to components.MuiContainer.props.fixed.name")

> **components.MuiContainer.props.fixed.name**: `string` = `"固定"`

#### components.MuiContainer.props.maxWidth[​](#componentsmuicontainerpropsmaxwidth "Direct link to components.MuiContainer.props.maxWidth")

> **components.MuiContainer.props.maxWidth**: `object`

#### components.MuiContainer.props.maxWidth.description[​](#componentsmuicontainerpropsmaxwidthdescription "Direct link to components.MuiContainer.props.maxWidth.description")

> **components.MuiContainer.props.maxWidth.description**: `string` = `"定义容器的最大宽度"`

#### components.MuiContainer.props.maxWidth.name[​](#componentsmuicontainerpropsmaxwidthname "Direct link to components.MuiContainer.props.maxWidth.name")

> **components.MuiContainer.props.maxWidth.name**: `string` = `"最大宽度"`

#### components.MuiErrorWrapper[​](#componentsmuierrorwrapper "Direct link to components.MuiErrorWrapper")

> **components.MuiErrorWrapper**: `object`

#### components.MuiErrorWrapper.description[​](#componentsmuierrorwrapperdescription "Direct link to components.MuiErrorWrapper.description")

> **components.MuiErrorWrapper.description**: `string` = `"包装内容并显示错误状态或消息"`

#### components.MuiErrorWrapper.name[​](#componentsmuierrorwrappername "Direct link to components.MuiErrorWrapper.name")

> **components.MuiErrorWrapper.name**: `string` = `"错误包装器"`

#### components.MuiFormControlLabel[​](#componentsmuiformcontrollabel "Direct link to components.MuiFormControlLabel")

> **components.MuiFormControlLabel**: `object`

#### components.MuiFormControlLabel.description[​](#componentsmuiformcontrollabeldescription "Direct link to components.MuiFormControlLabel.description")

> **components.MuiFormControlLabel.description**: `string` = `"将标签与表单控件关联"`

#### components.MuiFormControlLabel.name[​](#componentsmuiformcontrollabelname "Direct link to components.MuiFormControlLabel.name")

> **components.MuiFormControlLabel.name**: `string` = `"表格控制标签"`

#### components.MuiFormControlLabel.props[​](#componentsmuiformcontrollabelprops "Direct link to components.MuiFormControlLabel.props")

> **components.MuiFormControlLabel.props**: `object`

#### components.MuiFormControlLabel.props.control[​](#componentsmuiformcontrollabelpropscontrol "Direct link to components.MuiFormControlLabel.props.control")

> **components.MuiFormControlLabel.props.control**: `object`

#### components.MuiFormControlLabel.props.control.description[​](#componentsmuiformcontrollabelpropscontroldescription "Direct link to components.MuiFormControlLabel.props.control.description")

> **components.MuiFormControlLabel.props.control.description**: `string` = `"表单控制元素（复选框，收音机，开关）"`

#### components.MuiFormControlLabel.props.control.name[​](#componentsmuiformcontrollabelpropscontrolname "Direct link to components.MuiFormControlLabel.props.control.name")

> **components.MuiFormControlLabel.props.control.name**: `string` = `"控制"`

#### components.MuiFormControlLabel.props.labelPlacement[​](#componentsmuiformcontrollabelpropslabelplacement "Direct link to components.MuiFormControlLabel.props.labelPlacement")

> **components.MuiFormControlLabel.props.labelPlacement**: `object`

#### components.MuiFormControlLabel.props.labelPlacement.description[​](#componentsmuiformcontrollabelpropslabelplacementdescription "Direct link to components.MuiFormControlLabel.props.labelPlacement.description")

> **components.MuiFormControlLabel.props.labelPlacement.description**: `string` = `"标签相对于控件的位置"`

#### components.MuiFormControlLabel.props.labelPlacement.name[​](#componentsmuiformcontrollabelpropslabelplacementname "Direct link to components.MuiFormControlLabel.props.labelPlacement.name")

> **components.MuiFormControlLabel.props.labelPlacement.name**: `string` = `"标签放置"`

#### components.MuiFormLabel[​](#componentsmuiformlabel "Direct link to components.MuiFormLabel")

> **components.MuiFormLabel**: `object`

#### components.MuiFormLabel.description[​](#componentsmuiformlabeldescription "Direct link to components.MuiFormLabel.description")

> **components.MuiFormLabel.description**: `string` = `"用于分组或描述表单字段的标签"`

#### components.MuiFormLabel.name[​](#componentsmuiformlabelname "Direct link to components.MuiFormLabel.name")

> **components.MuiFormLabel.name**: `string` = `"表格标签"`

#### components.MuiFormLabel.props[​](#componentsmuiformlabelprops "Direct link to components.MuiFormLabel.props")

> **components.MuiFormLabel.props**: `object`

#### components.MuiFormLabel.props.filled[​](#componentsmuiformlabelpropsfilled "Direct link to components.MuiFormLabel.props.filled")

> **components.MuiFormLabel.props.filled**: `object`

#### components.MuiFormLabel.props.filled.description[​](#componentsmuiformlabelpropsfilleddescription "Direct link to components.MuiFormLabel.props.filled.description")

> **components.MuiFormLabel.props.filled.description**: `string` = `"应用填充状态样式"`

#### components.MuiFormLabel.props.filled.name[​](#componentsmuiformlabelpropsfilledname "Direct link to components.MuiFormLabel.props.filled.name")

> **components.MuiFormLabel.props.filled.name**: `string` = `"填满了"`

#### components.MuiLinearProgress[​](#componentsmuilinearprogress "Direct link to components.MuiLinearProgress")

> **components.MuiLinearProgress**: `object`

#### components.MuiLinearProgress.description[​](#componentsmuilinearprogressdescription "Direct link to components.MuiLinearProgress.description")

> **components.MuiLinearProgress.description**: `string` = `"指示线性条中的加载或进度"`

#### components.MuiLinearProgress.name[​](#componentsmuilinearprogressname "Direct link to components.MuiLinearProgress.name")

> **components.MuiLinearProgress.name**: `string` = `"线性进展"`

#### components.MuiLinearProgress.props[​](#componentsmuilinearprogressprops "Direct link to components.MuiLinearProgress.props")

> **components.MuiLinearProgress.props**: `object`

#### components.MuiLinearProgress.props.valueBuffer[​](#componentsmuilinearprogresspropsvaluebuffer "Direct link to components.MuiLinearProgress.props.valueBuffer")

> **components.MuiLinearProgress.props.valueBuffer**: `object`

#### components.MuiLinearProgress.props.valueBuffer.description[​](#componentsmuilinearprogresspropsvaluebufferdescription "Direct link to components.MuiLinearProgress.props.valueBuffer.description")

> **components.MuiLinearProgress.props.valueBuffer.description**: `string` = `"缓冲进度模式的辅助缓冲区值"`

#### components.MuiLinearProgress.props.valueBuffer.name[​](#componentsmuilinearprogresspropsvaluebuffername "Direct link to components.MuiLinearProgress.props.valueBuffer.name")

> **components.MuiLinearProgress.props.valueBuffer.name**: `string` = `"值缓冲区"`

#### components.MuiLink[​](#componentsmuilink "Direct link to components.MuiLink")

> **components.MuiLink**: `object`

#### components.MuiLink.description[​](#componentsmuilinkdescription "Direct link to components.MuiLink.description")

> **components.MuiLink.description**: `string` = `"用于导航或操作的可点击元素"`

#### components.MuiLink.name[​](#componentsmuilinkname "Direct link to components.MuiLink.name")

> **components.MuiLink.name**: `string` = `"连结"`

#### components.MuiLink.props[​](#componentsmuilinkprops "Direct link to components.MuiLink.props")

> **components.MuiLink.props**: `object`

#### components.MuiLink.props.href[​](#componentsmuilinkpropshref "Direct link to components.MuiLink.props.href")

> **components.MuiLink.props.href**: `object`

#### components.MuiLink.props.href.description[​](#componentsmuilinkpropshrefdescription "Direct link to components.MuiLink.props.href.description")

> **components.MuiLink.props.href.description**: `string` = `"目标URL"`

#### components.MuiLink.props.href.name[​](#componentsmuilinkpropshrefname "Direct link to components.MuiLink.props.href.name")

> **components.MuiLink.props.href.name**: `string` = `"Href"`

#### components.MuiList[​](#componentsmuilist "Direct link to components.MuiList")

> **components.MuiList**: `object`

#### components.MuiList.description[​](#componentsmuilistdescription "Direct link to components.MuiList.description")

> **components.MuiList.description**: `string` = `"显示项目的垂直列表"`

#### components.MuiList.name[​](#componentsmuilistname "Direct link to components.MuiList.name")

> **components.MuiList.name**: `string` = `"名单"`

#### components.MuiListItem[​](#componentsmuilistitem "Direct link to components.MuiListItem")

> **components.MuiListItem**: `object`

#### components.MuiListItem.description[​](#componentsmuilistitemdescription "Direct link to components.MuiListItem.description")

> **components.MuiListItem.description**: `string` = `"表示列表中的单个项"`

#### components.MuiListItem.name[​](#componentsmuilistitemname "Direct link to components.MuiListItem.name")

> **components.MuiListItem.name**: `string` = `"清单项目"`

#### components.MuiListItem.props[​](#componentsmuilistitemprops "Direct link to components.MuiListItem.props")

> **components.MuiListItem.props**: `object`

#### components.MuiListItem.props.divider[​](#componentsmuilistitempropsdivider "Direct link to components.MuiListItem.props.divider")

> **components.MuiListItem.props.divider**: `object`

#### components.MuiListItem.props.divider.description[​](#componentsmuilistitempropsdividerdescription "Direct link to components.MuiListItem.props.divider.description")

> **components.MuiListItem.props.divider.description**: `string` = `"在列表项下方显示分隔符"`

#### components.MuiListItem.props.divider.name[​](#componentsmuilistitempropsdividername "Direct link to components.MuiListItem.props.divider.name")

> **components.MuiListItem.props.divider.name**: `string` = `"分频器"`

#### components.MuiRadioGroup[​](#componentsmuiradiogroup "Direct link to components.MuiRadioGroup")

> **components.MuiRadioGroup**: `object`

#### components.MuiRadioGroup.description[​](#componentsmuiradiogroupdescription "Direct link to components.MuiRadioGroup.description")

> **components.MuiRadioGroup.description**: `string` = `"允许从集合中选择单个选项"`

#### components.MuiRadioGroup.name[​](#componentsmuiradiogroupname "Direct link to components.MuiRadioGroup.name")

> **components.MuiRadioGroup.name**: `string` = `"无线电组"`

#### components.MuiRadioGroup.props[​](#componentsmuiradiogroupprops "Direct link to components.MuiRadioGroup.props")

> **components.MuiRadioGroup.props**: `object`

#### components.MuiRadioGroup.props.name[​](#componentsmuiradiogrouppropsname "Direct link to components.MuiRadioGroup.props.name")

> **components.MuiRadioGroup.props.name**: `object`

#### components.MuiRadioGroup.props.name.description[​](#componentsmuiradiogrouppropsnamedescription "Direct link to components.MuiRadioGroup.props.name.description")

> **components.MuiRadioGroup.props.name.description**: `string` = `"用于分组单选按钮的Name属性"`

#### components.MuiRadioGroup.props.name.name[​](#componentsmuiradiogrouppropsnamename "Direct link to components.MuiRadioGroup.props.name.name")

> **components.MuiRadioGroup.props.name.name**: `string` = `"姓名"`

#### components.MuiRadioGroup.props.row[​](#componentsmuiradiogrouppropsrow "Direct link to components.MuiRadioGroup.props.row")

> **components.MuiRadioGroup.props.row**: `object`

#### components.MuiRadioGroup.props.row\.description[​](#componentsmuiradiogrouppropsrowdescription "Direct link to components.MuiRadioGroup.props.row.description")

> **components.MuiRadioGroup.props.row\.description**: `string` = `"水平显示单选按钮"`

#### components.MuiRadioGroup.props.row\.name[​](#componentsmuiradiogrouppropsrowname "Direct link to components.MuiRadioGroup.props.row.name")

> **components.MuiRadioGroup.props.row\.name**: `string` = `"排"`

#### components.MuiRadioItem[​](#componentsmuiradioitem "Direct link to components.MuiRadioItem")

> **components.MuiRadioItem**: `object`

#### components.MuiRadioItem.description[​](#componentsmuiradioitemdescription "Direct link to components.MuiRadioItem.description")

> **components.MuiRadioItem.description**: `string` = `"单选组中使用的单个单选按钮"`

#### components.MuiRadioItem.name[​](#componentsmuiradioitemname "Direct link to components.MuiRadioItem.name")

> **components.MuiRadioItem.name**: `string` = `"无线电项目"`

#### components.MuiSelect[​](#componentsmuiselect "Direct link to components.MuiSelect")

> **components.MuiSelect**: `object`

#### components.MuiSelect.description[​](#componentsmuiselectdescription "Direct link to components.MuiSelect.description")

> **components.MuiSelect.description**: `string` = `"用于选择选项的下拉组件"`

#### components.MuiSelect.name[​](#componentsmuiselectname "Direct link to components.MuiSelect.name")

> **components.MuiSelect.name**: `string` = `"选择"`

#### components.MuiSelect.props[​](#componentsmuiselectprops "Direct link to components.MuiSelect.props")

> **components.MuiSelect.props**: `object`

#### components.MuiSelect.props.autoFocus[​](#componentsmuiselectpropsautofocus "Direct link to components.MuiSelect.props.autoFocus")

> **components.MuiSelect.props.autoFocus**: `object`

#### components.MuiSelect.props.autoFocus.description[​](#componentsmuiselectpropsautofocusdescription "Direct link to components.MuiSelect.props.autoFocus.description")

> **components.MuiSelect.props.autoFocus.description**: `string` = `"自动将字段聚焦在mount上"`

#### components.MuiSelect.props.autoFocus.name[​](#componentsmuiselectpropsautofocusname "Direct link to components.MuiSelect.props.autoFocus.name")

> **components.MuiSelect.props.autoFocus.name**: `string` = `"自动对焦"`

#### components.MuiSelect.props.multiple[​](#componentsmuiselectpropsmultiple "Direct link to components.MuiSelect.props.multiple")

> **components.MuiSelect.props.multiple**: `object`

#### components.MuiSelect.props.multiple.description[​](#componentsmuiselectpropsmultipledescription "Direct link to components.MuiSelect.props.multiple.description")

> **components.MuiSelect.props.multiple.description**: `string` = `"允许选择多个选项"`

#### components.MuiSelect.props.multiple.name[​](#componentsmuiselectpropsmultiplename "Direct link to components.MuiSelect.props.multiple.name")

> **components.MuiSelect.props.multiple.name**: `string` = `"多个"`

#### components.MuiStack[​](#componentsmuistack "Direct link to components.MuiStack")

> **components.MuiStack**: `object`

#### components.MuiStack.description[​](#componentsmuistackdescription "Direct link to components.MuiStack.description")

> **components.MuiStack.description**: `string` = `"在一维堆栈中布局子项"`

#### components.MuiStack.name[​](#componentsmuistackname "Direct link to components.MuiStack.name")

> **components.MuiStack.name**: `string` = `"堆叠"`

#### components.MuiStack.props[​](#componentsmuistackprops "Direct link to components.MuiStack.props")

> **components.MuiStack.props**: `object`

#### components.MuiStack.props.alignItems[​](#componentsmuistackpropsalignitems "Direct link to components.MuiStack.props.alignItems")

> **components.MuiStack.props.alignItems**: `object`

#### components.MuiStack.props.alignItems.description[​](#componentsmuistackpropsalignitemsdescription "Direct link to components.MuiStack.props.alignItems.description")

> **components.MuiStack.props.alignItems.description**: `string` = `"控制跨轴对齐"`

#### components.MuiStack.props.alignItems.name[​](#componentsmuistackpropsalignitemsname "Direct link to components.MuiStack.props.alignItems.name")

> **components.MuiStack.props.alignItems.name**: `string` = `"对齐项目"`

#### components.MuiStack.props.direction[​](#componentsmuistackpropsdirection "Direct link to components.MuiStack.props.direction")

> **components.MuiStack.props.direction**: `object`

#### components.MuiStack.props.direction.description[​](#componentsmuistackpropsdirectiondescription "Direct link to components.MuiStack.props.direction.description")

> **components.MuiStack.props.direction.description**: `string` = `"定义项是堆叠在行还是列中"`

#### components.MuiStack.props.direction.name[​](#componentsmuistackpropsdirectionname "Direct link to components.MuiStack.props.direction.name")

> **components.MuiStack.props.direction.name**: `string` = `"方向感"`

#### components.MuiStack.props.flexWrap[​](#componentsmuistackpropsflexwrap "Direct link to components.MuiStack.props.flexWrap")

> **components.MuiStack.props.flexWrap**: `object`

#### components.MuiStack.props.flexWrap.description[​](#componentsmuistackpropsflexwrapdescription "Direct link to components.MuiStack.props.flexWrap.description")

> **components.MuiStack.props.flexWrap.description**: `string` = `"控制项是否换行到多行"`

#### components.MuiStack.props.flexWrap.name[​](#componentsmuistackpropsflexwrapname "Direct link to components.MuiStack.props.flexWrap.name")

> **components.MuiStack.props.flexWrap.name**: `string` = `"柔性包装"`

#### components.MuiStack.props.justifyContent[​](#componentsmuistackpropsjustifycontent "Direct link to components.MuiStack.props.justifyContent")

> **components.MuiStack.props.justifyContent**: `object`

#### components.MuiStack.props.justifyContent.description[​](#componentsmuistackpropsjustifycontentdescription "Direct link to components.MuiStack.props.justifyContent.description")

> **components.MuiStack.props.justifyContent.description**: `string` = `"控制主轴对齐"`

#### components.MuiStack.props.justifyContent.name[​](#componentsmuistackpropsjustifycontentname "Direct link to components.MuiStack.props.justifyContent.name")

> **components.MuiStack.props.justifyContent.name**: `string` = `"证明内容"`

#### components.MuiStack.props.spacing[​](#componentsmuistackpropsspacing "Direct link to components.MuiStack.props.spacing")

> **components.MuiStack.props.spacing**: `object`

#### components.MuiStack.props.spacing.description[​](#componentsmuistackpropsspacingdescription "Direct link to components.MuiStack.props.spacing.description")

> **components.MuiStack.props.spacing.description**: `string` = `"堆叠项目之间的间距"`

#### components.MuiStack.props.spacing.name[​](#componentsmuistackpropsspacingname "Direct link to components.MuiStack.props.spacing.name")

> **components.MuiStack.props.spacing.name**: `string` = `"间距"`

#### components.MuiStack.props.useFlexGap[​](#componentsmuistackpropsuseflexgap "Direct link to components.MuiStack.props.useFlexGap")

> **components.MuiStack.props.useFlexGap**: `object`

#### components.MuiStack.props.useFlexGap.description[​](#componentsmuistackpropsuseflexgapdescription "Direct link to components.MuiStack.props.useFlexGap.description")

> **components.MuiStack.props.useFlexGap.description**: `string` = `"使用CSS间隙而不是间距"`

#### components.MuiStack.props.useFlexGap.name[​](#componentsmuistackpropsuseflexgapname "Direct link to components.MuiStack.props.useFlexGap.name")

> **components.MuiStack.props.useFlexGap.name**: `string` = `"使用弹性间隙"`

#### components.MuiSwitch[​](#componentsmuiswitch "Direct link to components.MuiSwitch")

> **components.MuiSwitch**: `object`

#### components.MuiSwitch.description[​](#componentsmuiswitchdescription "Direct link to components.MuiSwitch.description")

> **components.MuiSwitch.description**: `string` = `"用于在两个状态之间切换的切换控制"`

#### components.MuiSwitch.name[​](#componentsmuiswitchname "Direct link to components.MuiSwitch.name")

> **components.MuiSwitch.name**: `string` = `"开关,开关"`

#### components.MuiSwitch.props[​](#componentsmuiswitchprops "Direct link to components.MuiSwitch.props")

> **components.MuiSwitch.props**: `object`

#### components.MuiSwitch.props.defaultChecked[​](#componentsmuiswitchpropsdefaultchecked "Direct link to components.MuiSwitch.props.defaultChecked")

> **components.MuiSwitch.props.defaultChecked**: `object`

#### components.MuiSwitch.props.defaultChecked.description[​](#componentsmuiswitchpropsdefaultcheckeddescription "Direct link to components.MuiSwitch.props.defaultChecked.description")

> **components.MuiSwitch.props.defaultChecked.description**: `string` = `"不受控制时的初始切换状态"`

#### components.MuiSwitch.props.defaultChecked.name[​](#componentsmuiswitchpropsdefaultcheckedname "Direct link to components.MuiSwitch.props.defaultChecked.name")

> **components.MuiSwitch.props.defaultChecked.name**: `string` = `"默认检查"`

#### components.MuiTextField[​](#componentsmuitextfield "Direct link to components.MuiTextField")

> **components.MuiTextField**: `object`

#### components.MuiTextField.description[​](#componentsmuitextfielddescription "Direct link to components.MuiTextField.description")

> **components.MuiTextField.description**: `string` = `"文本和表单数据的输入字段"`

#### components.MuiTextField.name[​](#componentsmuitextfieldname "Direct link to components.MuiTextField.name")

> **components.MuiTextField.name**: `string` = `"文本字段"`

#### components.MuiTextField.props[​](#componentsmuitextfieldprops "Direct link to components.MuiTextField.props")

> **components.MuiTextField.props**: `object`

#### components.MuiTextField.props.autoFocus[​](#componentsmuitextfieldpropsautofocus "Direct link to components.MuiTextField.props.autoFocus")

> **components.MuiTextField.props.autoFocus**: `object`

#### components.MuiTextField.props.autoFocus.description[​](#componentsmuitextfieldpropsautofocusdescription "Direct link to components.MuiTextField.props.autoFocus.description")

> **components.MuiTextField.props.autoFocus.description**: `string` = `"自动将字段聚焦在mount上"`

#### components.MuiTextField.props.autoFocus.name[​](#componentsmuitextfieldpropsautofocusname "Direct link to components.MuiTextField.props.autoFocus.name")

> **components.MuiTextField.props.autoFocus.name**: `string` = `"自动对焦"`

#### components.MuiTextField.props.maxRows[​](#componentsmuitextfieldpropsmaxrows "Direct link to components.MuiTextField.props.maxRows")

> **components.MuiTextField.props.maxRows**: `object`

#### components.MuiTextField.props.maxRows.description[​](#componentsmuitextfieldpropsmaxrowsdescription "Direct link to components.MuiTextField.props.maxRows.description")

> **components.MuiTextField.props.maxRows.description**: `string` = `"多行输入的最大可见行数"`

#### components.MuiTextField.props.maxRows.name[​](#componentsmuitextfieldpropsmaxrowsname "Direct link to components.MuiTextField.props.maxRows.name")

> **components.MuiTextField.props.maxRows.name**: `string` = `"最大行数"`

#### components.MuiTextField.props.multiline[​](#componentsmuitextfieldpropsmultiline "Direct link to components.MuiTextField.props.multiline")

> **components.MuiTextField.props.multiline**: `object`

#### components.MuiTextField.props.multiline.description[​](#componentsmuitextfieldpropsmultilinedescription "Direct link to components.MuiTextField.props.multiline.description")

> **components.MuiTextField.props.multiline.description**: `string` = `"呈现textarea而不是单行输入"`

#### components.MuiTextField.props.multiline.name[​](#componentsmuitextfieldpropsmultilinename "Direct link to components.MuiTextField.props.multiline.name")

> **components.MuiTextField.props.multiline.name**: `string` = `"多线"`

#### components.MuiTextField.props.type[​](#componentsmuitextfieldpropstype "Direct link to components.MuiTextField.props.type")

> **components.MuiTextField.props.type**: `object`

#### components.MuiTextField.props.type.description[​](#componentsmuitextfieldpropstypedescription "Direct link to components.MuiTextField.props.type.description")

> **components.MuiTextField.props.type.description**: `string` = `"HTML输入类型（文本，密码，电子邮件等）)"`

#### components.MuiTextField.props.type.name[​](#componentsmuitextfieldpropstypename "Direct link to components.MuiTextField.props.type.name")

> **components.MuiTextField.props.type.name**: `string` = `"类型"`

#### components.MuiTooltip[​](#componentsmuitooltip "Direct link to components.MuiTooltip")

> **components.MuiTooltip**: `object`

#### components.MuiTooltip.description[​](#componentsmuitooltipdescription "Direct link to components.MuiTooltip.description")

> **components.MuiTooltip.description**: `string` = `"在悬停、聚焦或触摸时显示上下文信息"`

#### components.MuiTooltip.name[​](#componentsmuitooltipname "Direct link to components.MuiTooltip.name")

> **components.MuiTooltip.name**: `string` = `"工具提示"`

#### components.MuiTooltip.props[​](#componentsmuitooltipprops "Direct link to components.MuiTooltip.props")

> **components.MuiTooltip.props**: `object`

#### components.MuiTooltip.props.arrow[​](#componentsmuitooltippropsarrow "Direct link to components.MuiTooltip.props.arrow")

> **components.MuiTooltip.props.arrow**: `object`

#### components.MuiTooltip.props.arrow\.description[​](#componentsmuitooltippropsarrowdescription "Direct link to components.MuiTooltip.props.arrow.description")

> **components.MuiTooltip.props.arrow\.description**: `string` = `"显示指向目标元素的箭头"`

#### components.MuiTooltip.props.arrow\.name[​](#componentsmuitooltippropsarrowname "Direct link to components.MuiTooltip.props.arrow.name")

> **components.MuiTooltip.props.arrow\.name**: `string` = `"箭头"`

#### components.MuiTooltip.props.disableFocusListener[​](#componentsmuitooltippropsdisablefocuslistener "Direct link to components.MuiTooltip.props.disableFocusListener")

> **components.MuiTooltip.props.disableFocusListener**: `object`

#### components.MuiTooltip.props.disableFocusListener.description[​](#componentsmuitooltippropsdisablefocuslistenerdescription "Direct link to components.MuiTooltip.props.disableFocusListener.description")

> **components.MuiTooltip.props.disableFocusListener.description**: `string` = `"防止工具提示出现在焦点上"`

#### components.MuiTooltip.props.disableFocusListener.name[​](#componentsmuitooltippropsdisablefocuslistenername "Direct link to components.MuiTooltip.props.disableFocusListener.name")

> **components.MuiTooltip.props.disableFocusListener.name**: `string` = `"禁用焦点侦听器"`

#### components.MuiTooltip.props.disableHoverListener[​](#componentsmuitooltippropsdisablehoverlistener "Direct link to components.MuiTooltip.props.disableHoverListener")

> **components.MuiTooltip.props.disableHoverListener**: `object`

#### components.MuiTooltip.props.disableHoverListener.description[​](#componentsmuitooltippropsdisablehoverlistenerdescription "Direct link to components.MuiTooltip.props.disableHoverListener.description")

> **components.MuiTooltip.props.disableHoverListener.description**: `string` = `"防止工具提示出现在悬停上"`

#### components.MuiTooltip.props.disableHoverListener.name[​](#componentsmuitooltippropsdisablehoverlistenername "Direct link to components.MuiTooltip.props.disableHoverListener.name")

> **components.MuiTooltip.props.disableHoverListener.name**: `string` = `"禁用悬停侦听器"`

#### components.MuiTooltip.props.disableInteractive[​](#componentsmuitooltippropsdisableinteractive "Direct link to components.MuiTooltip.props.disableInteractive")

> **components.MuiTooltip.props.disableInteractive**: `object`

#### components.MuiTooltip.props.disableInteractive.description[​](#componentsmuitooltippropsdisableinteractivedescription "Direct link to components.MuiTooltip.props.disableInteractive.description")

> **components.MuiTooltip.props.disableInteractive.description**: `string` = `"禁用与工具提示内容的交互"`

#### components.MuiTooltip.props.disableInteractive.name[​](#componentsmuitooltippropsdisableinteractivename "Direct link to components.MuiTooltip.props.disableInteractive.name")

> **components.MuiTooltip.props.disableInteractive.name**: `string` = `"禁用交互式"`

#### components.MuiTooltip.props.disableTouchListener[​](#componentsmuitooltippropsdisabletouchlistener "Direct link to components.MuiTooltip.props.disableTouchListener")

> **components.MuiTooltip.props.disableTouchListener**: `object`

#### components.MuiTooltip.props.disableTouchListener.description[​](#componentsmuitooltippropsdisabletouchlistenerdescription "Direct link to components.MuiTooltip.props.disableTouchListener.description")

> **components.MuiTooltip.props.disableTouchListener.description**: `string` = `"防止工具提示出现在触摸上"`

#### components.MuiTooltip.props.disableTouchListener.name[​](#componentsmuitooltippropsdisabletouchlistenername "Direct link to components.MuiTooltip.props.disableTouchListener.name")

> **components.MuiTooltip.props.disableTouchListener.name**: `string` = `"禁用触摸侦听器"`

#### components.MuiTooltip.props.enterDelay[​](#componentsmuitooltippropsenterdelay "Direct link to components.MuiTooltip.props.enterDelay")

> **components.MuiTooltip.props.enterDelay**: `object`

#### components.MuiTooltip.props.enterDelay.description[​](#componentsmuitooltippropsenterdelaydescription "Direct link to components.MuiTooltip.props.enterDelay.description")

> **components.MuiTooltip.props.enterDelay.description**: `string` = `"在显示工具提示之前以毫秒为单位的延迟"`

#### components.MuiTooltip.props.enterDelay.name[​](#componentsmuitooltippropsenterdelayname "Direct link to components.MuiTooltip.props.enterDelay.name")

> **components.MuiTooltip.props.enterDelay.name**: `string` = `"输入延迟"`

#### components.MuiTooltip.props.followCursor[​](#componentsmuitooltippropsfollowcursor "Direct link to components.MuiTooltip.props.followCursor")

> **components.MuiTooltip.props.followCursor**: `object`

#### components.MuiTooltip.props.followCursor.description[​](#componentsmuitooltippropsfollowcursordescription "Direct link to components.MuiTooltip.props.followCursor.description")

> **components.MuiTooltip.props.followCursor.description**: `string` = `"使工具提示跟随光标位置"`

#### components.MuiTooltip.props.followCursor.name[​](#componentsmuitooltippropsfollowcursorname "Direct link to components.MuiTooltip.props.followCursor.name")

> **components.MuiTooltip.props.followCursor.name**: `string` = `"跟随光标"`

#### components.MuiTooltip.props.leaveDelay[​](#componentsmuitooltippropsleavedelay "Direct link to components.MuiTooltip.props.leaveDelay")

> **components.MuiTooltip.props.leaveDelay**: `object`

#### components.MuiTooltip.props.leaveDelay.description[​](#componentsmuitooltippropsleavedelaydescription "Direct link to components.MuiTooltip.props.leaveDelay.description")

> **components.MuiTooltip.props.leaveDelay.description**: `string` = `"隐藏工具提示之前的延迟（以毫秒为单位）"`

#### components.MuiTooltip.props.leaveDelay.name[​](#componentsmuitooltippropsleavedelayname "Direct link to components.MuiTooltip.props.leaveDelay.name")

> **components.MuiTooltip.props.leaveDelay.name**: `string` = `"请假延误"`

#### components.MuiTooltip.props.title[​](#componentsmuitooltippropstitle "Direct link to components.MuiTooltip.props.title")

> **components.MuiTooltip.props.title**: `object`

#### components.MuiTooltip.props.title.description[​](#componentsmuitooltippropstitledescription "Direct link to components.MuiTooltip.props.title.description")

> **components.MuiTooltip.props.title.description**: `string` = `"工具提示内显示的文本内容"`

#### components.MuiTooltip.props.title.name[​](#componentsmuitooltippropstitlename "Direct link to components.MuiTooltip.props.title.name")

> **components.MuiTooltip.props.title.name**: `string` = `"标题"`

#### components.MuiTypography[​](#componentsmuitypography "Direct link to components.MuiTypography")

> **components.MuiTypography**: `object`

#### components.MuiTypography.description[​](#componentsmuitypographydescription "Direct link to components.MuiTypography.description")

> **components.MuiTypography.description**: `string` = `"显示具有预定义排版样式的文本"`

#### components.MuiTypography.name[​](#componentsmuitypographyname "Direct link to components.MuiTypography.name")

> **components.MuiTypography.name**: `string` = `"印刷术"`

#### components.MuiTypography.props[​](#componentsmuitypographyprops "Direct link to components.MuiTypography.props")

> **components.MuiTypography.props**: `object`

#### components.MuiTypography.props.children[​](#componentsmuitypographypropschildren "Direct link to components.MuiTypography.props.children")

> **components.MuiTypography.props.children**: `object`

#### components.MuiTypography.props.children.description[​](#componentsmuitypographypropschildrendescription "Direct link to components.MuiTypography.props.children.description")

> **components.MuiTypography.props.children.description**: `string` = `"文本内容"`

#### components.MuiTypography.props.children.name[​](#componentsmuitypographypropschildrenname "Direct link to components.MuiTypography.props.children.name")

> **components.MuiTypography.props.children.name**: `string` = `"内容"`

#### components.MuiUploader[​](#componentsmuiuploader "Direct link to components.MuiUploader")

> **components.MuiUploader**: `object`

#### components.MuiUploader.description[​](#componentsmuiuploaderdescription "Direct link to components.MuiUploader.description")

> **components.MuiUploader.description**: `string` = `"用于上传一个或多个文件的组件"`

#### components.MuiUploader.name[​](#componentsmuiuploadername "Direct link to components.MuiUploader.name")

> **components.MuiUploader.name**: `string` = `"上传者"`

#### components.MuiUploader.props[​](#componentsmuiuploaderprops "Direct link to components.MuiUploader.props")

> **components.MuiUploader.props**: `object`

#### components.MuiUploader.props.accept[​](#componentsmuiuploaderpropsaccept "Direct link to components.MuiUploader.props.accept")

> **components.MuiUploader.props.accept**: `object`

#### components.MuiUploader.props.accept.description[​](#componentsmuiuploaderpropsacceptdescription "Direct link to components.MuiUploader.props.accept.description")

> **components.MuiUploader.props.accept.description**: `string` = `"允许的文件类型（例如\"。jpg，。png\"）"`

#### components.MuiUploader.props.accept.name[​](#componentsmuiuploaderpropsacceptname "Direct link to components.MuiUploader.props.accept.name")

> **components.MuiUploader.props.accept.name**: `string` = `"接受"`

#### components.MuiUploader.props.multiple[​](#componentsmuiuploaderpropsmultiple "Direct link to components.MuiUploader.props.multiple")

> **components.MuiUploader.props.multiple**: `object`

#### components.MuiUploader.props.multiple.description[​](#componentsmuiuploaderpropsmultipledescription "Direct link to components.MuiUploader.props.multiple.description")

> **components.MuiUploader.props.multiple.description**: `string` = `"允许选择多个文件"`

#### components.MuiUploader.props.multiple.name[​](#componentsmuiuploaderpropsmultiplename "Direct link to components.MuiUploader.props.multiple.name")

> **components.MuiUploader.props.multiple.name**: `string` = `"多个"`


---

# Variable: view

> `const` **view**: [`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

An assembled set of Material UI components, ready to be passed as a property to the FormViewer.


---

# @react-form-builder/components-rich-text

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [RichTextEditorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/interfaces/RichTextEditorProps)

## Variables[​](#variables "Direct link to Variables")

* [richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextComponent)
* [richTextEditorComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorComponentsDescriptions)
* [richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorEnUsComponentsDescriptions)
* [richTextModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextModel)


---

# Interface: RichTextEditorProps

The Rich text editor component properties.

## Extends[​](#extends "Direct link to Extends")

* `ReactQuillProps`

## Properties[​](#properties "Direct link to Properties")

### bounds?[​](#bounds "Direct link to bounds?")

> `optional` **bounds**: `string` | `HTMLElement`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.bounds`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactElement`<`any`, `string` | `JSXElementConstructor`<`any`>>

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

#### Overrides[​](#overrides "Direct link to Overrides")

`ReactQuill.ReactQuillProps.className`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `Value`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.defaultValue`

***

### formats?[​](#formats "Direct link to formats?")

> `optional` **formats**: `string`\[]

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.formats`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.id`

***

### initialValue?[​](#initialvalue "Direct link to initialValue?")

> `optional` **initialValue**: `string`

The initial value for the editor.

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the component.

***

### modules?[​](#modules "Direct link to modules?")

> `optional` **modules**: `Record`<`string`, `unknown`>

Allows to customize the behavior and functionality of the editor.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`ReactQuill.ReactQuillProps.modules`

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`value?`) => `void`

Triggered after the content changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value?[​](#value "Direct link to value?")

`string`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides-2 "Direct link to Overrides")

`ReactQuill.ReactQuillProps.onChange`

***

### onKeyDown()?[​](#onkeydown "Direct link to onKeyDown()?")

> `optional` **onKeyDown**: (`event`) => `void`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`any`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onKeyDown`

***

### onKeyPress()?[​](#onkeypress "Direct link to onKeyPress()?")

> `optional` **onKeyPress**: (`event`) => `void`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### event[​](#event-1 "Direct link to event")

`any`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onKeyPress`

***

### onKeyUp()?[​](#onkeyup "Direct link to onKeyUp()?")

> `optional` **onKeyUp**: (`event`) => `void`

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`any`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onKeyUp`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.placeholder`

***

### preserveWhitespace?[​](#preservewhitespace "Direct link to preserveWhitespace?")

> `optional` **preserveWhitespace**: `boolean`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.preserveWhitespace`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.readOnly`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.style`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.tabIndex`

***

### theme?[​](#theme "Direct link to theme?")

> `optional` **theme**: `string`

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.theme`

***

### toolbarOptions?[​](#toolbaroptions "Direct link to toolbarOptions?")

> `optional` **toolbarOptions**: (`"block"` | `"color"` | `"direction"` | `"font"` | `"header"` | `"script"` | `"insert"` | `"size"` | `"list"` | `"clean"` | `"align"` | `"decoration"` | `"indent"`)\[]

Groups of buttons to be displayed on the toolbar.

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `Value`

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.value`

## Methods[​](#methods "Direct link to Methods")

### onBlur()?[​](#onblur "Direct link to onBlur()?")

> `optional` **onBlur**(`previousSelection`, `source`, `editor`): `void`

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### previousSelection[​](#previousselection "Direct link to previousSelection")

`Range`

##### source[​](#source "Direct link to source")

`EmitterSource`

##### editor[​](#editor "Direct link to editor")

`UnprivilegedEditor`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onBlur`

***

### onChangeSelection()?[​](#onchangeselection "Direct link to onChangeSelection()?")

> `optional` **onChangeSelection**(`selection`, `source`, `editor`): `void`

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### selection[​](#selection "Direct link to selection")

`Range`

##### source[​](#source-1 "Direct link to source")

`EmitterSource`

##### editor[​](#editor-1 "Direct link to editor")

`UnprivilegedEditor`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onChangeSelection`

***

### onFocus()?[​](#onfocus "Direct link to onFocus()?")

> `optional` **onFocus**(`selection`, `source`, `editor`): `void`

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### selection[​](#selection-1 "Direct link to selection")

`Range`

##### source[​](#source-2 "Direct link to source")

`EmitterSource`

##### editor[​](#editor-2 "Direct link to editor")

`UnprivilegedEditor`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onFocus`


---

# Variable: richTextComponent

> `const` **richTextComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RichTextEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/interfaces/RichTextEditorProps)> = `richTextEditor`


---

# Variable: richTextEditorComponentsDescriptions

> `const` **richTextEditorComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: richTextEditorEnUsComponentsDescriptions

> **richTextEditorEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.fields[​](#categoriesfields "Direct link to categories.fields")

> **categories.fields**: `object`

#### categories.fields.name[​](#categoriesfieldsname "Direct link to categories.fields.name")

> **categories.fields.name**: `string` = `"Fields"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.RichTextEditor[​](#componentsrichtexteditor "Direct link to components.RichTextEditor")

> **components.RichTextEditor**: `object`

#### components.RichTextEditor.description[​](#componentsrichtexteditordescription "Direct link to components.RichTextEditor.description")

> **components.RichTextEditor.description**: `string` = `"Your powerful rich text editor"`

#### components.RichTextEditor.name[​](#componentsrichtexteditorname "Direct link to components.RichTextEditor.name")

> **components.RichTextEditor.name**: `string` = `"Rich text editor"`

#### components.RichTextEditor.props[​](#componentsrichtexteditorprops "Direct link to components.RichTextEditor.props")

> **components.RichTextEditor.props**: `object`

#### components.RichTextEditor.props.initialValue[​](#componentsrichtexteditorpropsinitialvalue "Direct link to components.RichTextEditor.props.initialValue")

> **components.RichTextEditor.props.initialValue**: `object`

#### components.RichTextEditor.props.initialValue.description[​](#componentsrichtexteditorpropsinitialvaluedescription "Direct link to components.RichTextEditor.props.initialValue.description")

> **components.RichTextEditor.props.initialValue.description**: `string` = `"The initial value"`

#### components.RichTextEditor.props.initialValue.name[​](#componentsrichtexteditorpropsinitialvaluename "Direct link to components.RichTextEditor.props.initialValue.name")

> **components.RichTextEditor.props.initialValue.name**: `string` = `"Initial value"`

#### components.RichTextEditor.props.label[​](#componentsrichtexteditorpropslabel "Direct link to components.RichTextEditor.props.label")

> **components.RichTextEditor.props.label**: `object`

#### components.RichTextEditor.props.label.description[​](#componentsrichtexteditorpropslabeldescription "Direct link to components.RichTextEditor.props.label.description")

> **components.RichTextEditor.props.label.description**: `string` = `"The label"`

#### components.RichTextEditor.props.label.name[​](#componentsrichtexteditorpropslabelname "Direct link to components.RichTextEditor.props.label.name")

> **components.RichTextEditor.props.label.name**: `string` = `"Label"`

#### components.RichTextEditor.props.modules[​](#componentsrichtexteditorpropsmodules "Direct link to components.RichTextEditor.props.modules")

> **components.RichTextEditor.props.modules**: `object`

#### components.RichTextEditor.props.modules.description[​](#componentsrichtexteditorpropsmodulesdescription "Direct link to components.RichTextEditor.props.modules.description")

> **components.RichTextEditor.props.modules.description**: `string` = `"Allows to customize the behavior and functionality of the editor. Read docs for more info"`

#### components.RichTextEditor.props.modules.name[​](#componentsrichtexteditorpropsmodulesname "Direct link to components.RichTextEditor.props.modules.name")

> **components.RichTextEditor.props.modules.name**: `string` = `"Modules"`

#### components.RichTextEditor.props.placeholder[​](#componentsrichtexteditorpropsplaceholder "Direct link to components.RichTextEditor.props.placeholder")

> **components.RichTextEditor.props.placeholder**: `object`

#### components.RichTextEditor.props.placeholder.description[​](#componentsrichtexteditorpropsplaceholderdescription "Direct link to components.RichTextEditor.props.placeholder.description")

> **components.RichTextEditor.props.placeholder.description**: `string` = `"The placeholder"`

#### components.RichTextEditor.props.placeholder.name[​](#componentsrichtexteditorpropsplaceholdername "Direct link to components.RichTextEditor.props.placeholder.name")

> **components.RichTextEditor.props.placeholder.name**: `string` = `"Placeholder"`

#### components.RichTextEditor.props.readOnly[​](#componentsrichtexteditorpropsreadonly "Direct link to components.RichTextEditor.props.readOnly")

> **components.RichTextEditor.props.readOnly**: `object`

#### components.RichTextEditor.props.readOnly.description[​](#componentsrichtexteditorpropsreadonlydescription "Direct link to components.RichTextEditor.props.readOnly.description")

> **components.RichTextEditor.props.readOnly.description**: `string` = `"Read-only flag"`

#### components.RichTextEditor.props.readOnly.name[​](#componentsrichtexteditorpropsreadonlyname "Direct link to components.RichTextEditor.props.readOnly.name")

> **components.RichTextEditor.props.readOnly.name**: `string` = `"Read only"`

#### components.RichTextEditor.props.toolbarOptions[​](#componentsrichtexteditorpropstoolbaroptions "Direct link to components.RichTextEditor.props.toolbarOptions")

> **components.RichTextEditor.props.toolbarOptions**: `object`

#### components.RichTextEditor.props.toolbarOptions.description[​](#componentsrichtexteditorpropstoolbaroptionsdescription "Direct link to components.RichTextEditor.props.toolbarOptions.description")

> **components.RichTextEditor.props.toolbarOptions.description**: `string` = `"Groups of buttons to be displayed on the toolbar"`

#### components.RichTextEditor.props.toolbarOptions.name[​](#componentsrichtexteditorpropstoolbaroptionsname "Direct link to components.RichTextEditor.props.toolbarOptions.name")

> **components.RichTextEditor.props.toolbarOptions.name**: `string` = `"Toolbar options"`


---

# Variable: richTextModel

> `const` **richTextModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# @react-form-builder/components-rsuite-table

## Variables[​](#variables "Direct link to Variables")

* [rSuiteTableComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/rSuiteTableComponents)
* [rSuiteTableComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/rSuiteTableComponentsDescriptions)
* [rSuiteTableEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/rSuiteTableEnUsComponentsDescriptions)
* [tableModels](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite-table/variables/tableModels)


---

# Variable: rSuiteTableComponents

> `const` **rSuiteTableComponents**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`any`>\[] = `[]`

An array of rSuite table component metadata factories.


---

# Variable: rSuiteTableComponentsDescriptions

> `const` **rSuiteTableComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: rSuiteTableEnUsComponentsDescriptions

> **rSuiteTableEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.structure[​](#categoriesstructure "Direct link to categories.structure")

> **categories.structure**: `object`

#### categories.structure.name[​](#categoriesstructurename "Direct link to categories.structure.name")

> **categories.structure.name**: `string` = `"Structure"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.RsCell[​](#componentsrscell "Direct link to components.RsCell")

> **components.RsCell**: `object`

#### components.RsCell.description[​](#componentsrscelldescription "Direct link to components.RsCell.description")

> **components.RsCell.description**: `string` = `"Table cell"`

#### components.RsCell.name[​](#componentsrscellname "Direct link to components.RsCell.name")

> **components.RsCell.name**: `string` = `"Cell"`

#### components.RsCell.props[​](#componentsrscellprops "Direct link to components.RsCell.props")

> **components.RsCell.props**: `object`

#### components.RsCell.props.dataKey[​](#componentsrscellpropsdatakey "Direct link to components.RsCell.props.dataKey")

> **components.RsCell.props.dataKey**: `object`

#### components.RsCell.props.dataKey.description[​](#componentsrscellpropsdatakeydescription "Direct link to components.RsCell.props.dataKey.description")

> **components.RsCell.props.dataKey.description**: `string` = `"Data binding key, but also a sort of key"`

#### components.RsCell.props.dataKey.name[​](#componentsrscellpropsdatakeyname "Direct link to components.RsCell.props.dataKey.name")

> **components.RsCell.props.dataKey.name**: `string` = `"Data key"`

#### components.RsColumn[​](#componentsrscolumn "Direct link to components.RsColumn")

> **components.RsColumn**: `object`

#### components.RsColumn.description[​](#componentsrscolumndescription "Direct link to components.RsColumn.description")

> **components.RsColumn.description**: `string` = `"Table column"`

#### components.RsColumn.name[​](#componentsrscolumnname "Direct link to components.RsColumn.name")

> **components.RsColumn.name**: `string` = `"Column"`

#### components.RsColumn.props[​](#componentsrscolumnprops "Direct link to components.RsColumn.props")

> **components.RsColumn.props**: `object`

#### components.RsColumn.props.align[​](#componentsrscolumnpropsalign "Direct link to components.RsColumn.props.align")

> **components.RsColumn.props.align**: `object`

#### components.RsColumn.props.align.description[​](#componentsrscolumnpropsaligndescription "Direct link to components.RsColumn.props.align.description")

> **components.RsColumn.props.align.description**: `string` = `"Alignment"`

#### components.RsColumn.props.align.name[​](#componentsrscolumnpropsalignname "Direct link to components.RsColumn.props.align.name")

> **components.RsColumn.props.align.name**: `string` = `"Align"`

#### components.RsColumn.props.colSpan[​](#componentsrscolumnpropscolspan "Direct link to components.RsColumn.props.colSpan")

> **components.RsColumn.props.colSpan**: `object`

#### components.RsColumn.props.colSpan.description[​](#componentsrscolumnpropscolspandescription "Direct link to components.RsColumn.props.colSpan.description")

> **components.RsColumn.props.colSpan.description**: `string` = `"Merges column cells to merge when the 'Data key' value for the merged column is null or undefined"`

#### components.RsColumn.props.colSpan.name[​](#componentsrscolumnpropscolspanname "Direct link to components.RsColumn.props.colSpan.name")

> **components.RsColumn.props.colSpan.name**: `string` = `"Col span"`

#### components.RsColumn.props.fixed[​](#componentsrscolumnpropsfixed "Direct link to components.RsColumn.props.fixed")

> **components.RsColumn.props.fixed**: `object`

#### components.RsColumn.props.fixed.description[​](#componentsrscolumnpropsfixeddescription "Direct link to components.RsColumn.props.fixed.description")

> **components.RsColumn.props.fixed.description**: `string` = `"Fixed column"`

#### components.RsColumn.props.fixed.name[​](#componentsrscolumnpropsfixedname "Direct link to components.RsColumn.props.fixed.name")

> **components.RsColumn.props.fixed.name**: `string` = `"Fixed"`

#### components.RsColumn.props.flexGrow[​](#componentsrscolumnpropsflexgrow "Direct link to components.RsColumn.props.flexGrow")

> **components.RsColumn.props.flexGrow**: `object`

#### components.RsColumn.props.flexGrow\.description[​](#componentsrscolumnpropsflexgrowdescription "Direct link to components.RsColumn.props.flexGrow.description")

> **components.RsColumn.props.flexGrow\.description**: `string` = `"Set the column width automatically adjusts, when set 'Flex grow' cannot set 'Resizable' and 'Width' property"`

#### components.RsColumn.props.flexGrow\.name[​](#componentsrscolumnpropsflexgrowname "Direct link to components.RsColumn.props.flexGrow.name")

> **components.RsColumn.props.flexGrow\.name**: `string` = `"Flex grow"`

#### components.RsColumn.props.fullText[​](#componentsrscolumnpropsfulltext "Direct link to components.RsColumn.props.fullText")

> **components.RsColumn.props.fullText**: `object`

#### components.RsColumn.props.fullText.description[​](#componentsrscolumnpropsfulltextdescription "Direct link to components.RsColumn.props.fullText.description")

> **components.RsColumn.props.fullText.description**: `string` = `"Whether to display the full text of the cell content when the mouse is hovered"`

#### components.RsColumn.props.fullText.name[​](#componentsrscolumnpropsfulltextname "Direct link to components.RsColumn.props.fullText.name")

> **components.RsColumn.props.fullText.name**: `string` = `"Full text"`

#### components.RsColumn.props.minWidth[​](#componentsrscolumnpropsminwidth "Direct link to components.RsColumn.props.minWidth")

> **components.RsColumn.props.minWidth**: `object`

#### components.RsColumn.props.minWidth.description[​](#componentsrscolumnpropsminwidthdescription "Direct link to components.RsColumn.props.minWidth.description")

> **components.RsColumn.props.minWidth.description**: `string` = `"When you use 'Flex grow', you can set a minimum width"`

#### components.RsColumn.props.minWidth.name[​](#componentsrscolumnpropsminwidthname "Direct link to components.RsColumn.props.minWidth.name")

> **components.RsColumn.props.minWidth.name**: `string` = `"Min width"`

#### components.RsColumn.props.resizable[​](#componentsrscolumnpropsresizable "Direct link to components.RsColumn.props.resizable")

> **components.RsColumn.props.resizable**: `object`

#### components.RsColumn.props.resizable.description[​](#componentsrscolumnpropsresizabledescription "Direct link to components.RsColumn.props.resizable.description")

> **components.RsColumn.props.resizable.description**: `string` = `"Customizable resize column width"`

#### components.RsColumn.props.resizable.name[​](#componentsrscolumnpropsresizablename "Direct link to components.RsColumn.props.resizable.name")

> **components.RsColumn.props.resizable.name**: `string` = `"Resizable"`

#### components.RsColumn.props.rowSpan[​](#componentsrscolumnpropsrowspan "Direct link to components.RsColumn.props.rowSpan")

> **components.RsColumn.props.rowSpan**: `object`

#### components.RsColumn.props.rowSpan.description[​](#componentsrscolumnpropsrowspandescription "Direct link to components.RsColumn.props.rowSpan.description")

> **components.RsColumn.props.rowSpan.description**: `string` = `"Merges rows on the specified column"`

#### components.RsColumn.props.rowSpan.name[​](#componentsrscolumnpropsrowspanname "Direct link to components.RsColumn.props.rowSpan.name")

> **components.RsColumn.props.rowSpan.name**: `string` = `"Row span"`

#### components.RsColumn.props.sortable[​](#componentsrscolumnpropssortable "Direct link to components.RsColumn.props.sortable")

> **components.RsColumn.props.sortable**: `object`

#### components.RsColumn.props.sortable.description[​](#componentsrscolumnpropssortabledescription "Direct link to components.RsColumn.props.sortable.description")

> **components.RsColumn.props.sortable.description**: `string` = `"Sortable"`

#### components.RsColumn.props.sortable.name[​](#componentsrscolumnpropssortablename "Direct link to components.RsColumn.props.sortable.name")

> **components.RsColumn.props.sortable.name**: `string` = `"Sortable"`

#### components.RsColumn.props.verticalAlign[​](#componentsrscolumnpropsverticalalign "Direct link to components.RsColumn.props.verticalAlign")

> **components.RsColumn.props.verticalAlign**: `object`

#### components.RsColumn.props.verticalAlign.description[​](#componentsrscolumnpropsverticalaligndescription "Direct link to components.RsColumn.props.verticalAlign.description")

> **components.RsColumn.props.verticalAlign.description**: `string` = `"Vertical alignment"`

#### components.RsColumn.props.verticalAlign.name[​](#componentsrscolumnpropsverticalalignname "Direct link to components.RsColumn.props.verticalAlign.name")

> **components.RsColumn.props.verticalAlign.name**: `string` = `"Vertical align"`

#### components.RsColumn.props.width[​](#componentsrscolumnpropswidth "Direct link to components.RsColumn.props.width")

> **components.RsColumn.props.width**: `object`

#### components.RsColumn.props.width.description[​](#componentsrscolumnpropswidthdescription "Direct link to components.RsColumn.props.width.description")

> **components.RsColumn.props.width.description**: `string` = `"Column width"`

#### components.RsColumn.props.width.name[​](#componentsrscolumnpropswidthname "Direct link to components.RsColumn.props.width.name")

> **components.RsColumn.props.width.name**: `string` = `"Width"`

#### components.RsColumnGroup[​](#componentsrscolumngroup "Direct link to components.RsColumnGroup")

> **components.RsColumnGroup**: `object`

#### components.RsColumnGroup.description[​](#componentsrscolumngroupdescription "Direct link to components.RsColumnGroup.description")

> **components.RsColumnGroup.description**: `string` = `"Table column group"`

#### components.RsColumnGroup.name[​](#componentsrscolumngroupname "Direct link to components.RsColumnGroup.name")

> **components.RsColumnGroup.name**: `string` = `"Column group"`

#### components.RsColumnGroup.props[​](#componentsrscolumngroupprops "Direct link to components.RsColumnGroup.props")

> **components.RsColumnGroup.props**: `object`

#### components.RsColumnGroup.props.align[​](#componentsrscolumngrouppropsalign "Direct link to components.RsColumnGroup.props.align")

> **components.RsColumnGroup.props.align**: `object`

#### components.RsColumnGroup.props.align.description[​](#componentsrscolumngrouppropsaligndescription "Direct link to components.RsColumnGroup.props.align.description")

> **components.RsColumnGroup.props.align.description**: `string` = `"Alignment"`

#### components.RsColumnGroup.props.align.name[​](#componentsrscolumngrouppropsalignname "Direct link to components.RsColumnGroup.props.align.name")

> **components.RsColumnGroup.props.align.name**: `string` = `"Align"`

#### components.RsColumnGroup.props.fixed[​](#componentsrscolumngrouppropsfixed "Direct link to components.RsColumnGroup.props.fixed")

> **components.RsColumnGroup.props.fixed**: `object`

#### components.RsColumnGroup.props.fixed.description[​](#componentsrscolumngrouppropsfixeddescription "Direct link to components.RsColumnGroup.props.fixed.description")

> **components.RsColumnGroup.props.fixed.description**: `string` = `"Fixed column group"`

#### components.RsColumnGroup.props.fixed.name[​](#componentsrscolumngrouppropsfixedname "Direct link to components.RsColumnGroup.props.fixed.name")

> **components.RsColumnGroup.props.fixed.name**: `string` = `"Fixed"`

#### components.RsColumnGroup.props.groupHeaderHeight[​](#componentsrscolumngrouppropsgroupheaderheight "Direct link to components.RsColumnGroup.props.groupHeaderHeight")

> **components.RsColumnGroup.props.groupHeaderHeight**: `object`

#### components.RsColumnGroup.props.groupHeaderHeight.description[​](#componentsrscolumngrouppropsgroupheaderheightdescription "Direct link to components.RsColumnGroup.props.groupHeaderHeight.description")

> **components.RsColumnGroup.props.groupHeaderHeight.description**: `string` = `"The height of the header of the merged cell group"`

#### components.RsColumnGroup.props.groupHeaderHeight.name[​](#componentsrscolumngrouppropsgroupheaderheightname "Direct link to components.RsColumnGroup.props.groupHeaderHeight.name")

> **components.RsColumnGroup.props.groupHeaderHeight.name**: `string` = `"Group header height"`

#### components.RsColumnGroup.props.header[​](#componentsrscolumngrouppropsheader "Direct link to components.RsColumnGroup.props.header")

> **components.RsColumnGroup.props.header**: `object`

#### components.RsColumnGroup.props.header.description[​](#componentsrscolumngrouppropsheaderdescription "Direct link to components.RsColumnGroup.props.header.description")

> **components.RsColumnGroup.props.header.description**: `string` = `"Group header"`

#### components.RsColumnGroup.props.header.name[​](#componentsrscolumngrouppropsheadername "Direct link to components.RsColumnGroup.props.header.name")

> **components.RsColumnGroup.props.header.name**: `string` = `"Header"`

#### components.RsColumnGroup.props.verticalAlign[​](#componentsrscolumngrouppropsverticalalign "Direct link to components.RsColumnGroup.props.verticalAlign")

> **components.RsColumnGroup.props.verticalAlign**: `object`

#### components.RsColumnGroup.props.verticalAlign.description[​](#componentsrscolumngrouppropsverticalaligndescription "Direct link to components.RsColumnGroup.props.verticalAlign.description")

> **components.RsColumnGroup.props.verticalAlign.description**: `string` = `"Vertical alignment"`

#### components.RsColumnGroup.props.verticalAlign.name[​](#componentsrscolumngrouppropsverticalalignname "Direct link to components.RsColumnGroup.props.verticalAlign.name")

> **components.RsColumnGroup.props.verticalAlign.name**: `string` = `"Vertical align"`

#### components.RsHeaderCell[​](#componentsrsheadercell "Direct link to components.RsHeaderCell")

> **components.RsHeaderCell**: `object`

#### components.RsHeaderCell.description[​](#componentsrsheadercelldescription "Direct link to components.RsHeaderCell.description")

> **components.RsHeaderCell.description**: `string` = `"Table header cell"`

#### components.RsHeaderCell.name[​](#componentsrsheadercellname "Direct link to components.RsHeaderCell.name")

> **components.RsHeaderCell.name**: `string` = `"Header cell"`

#### components.RsHeaderCell.props[​](#componentsrsheadercellprops "Direct link to components.RsHeaderCell.props")

> **components.RsHeaderCell.props**: `object`

#### components.RsHeaderCell.props.children[​](#componentsrsheadercellpropschildren "Direct link to components.RsHeaderCell.props.children")

> **components.RsHeaderCell.props.children**: `object`

#### components.RsHeaderCell.props.children.description[​](#componentsrsheadercellpropschildrendescription "Direct link to components.RsHeaderCell.props.children.description")

> **components.RsHeaderCell.props.children.description**: `string` = `"Table column header"`

#### components.RsHeaderCell.props.children.name[​](#componentsrsheadercellpropschildrenname "Direct link to components.RsHeaderCell.props.children.name")

> **components.RsHeaderCell.props.children.name**: `string` = `"Content"`

#### components.RsTable[​](#componentsrstable "Direct link to components.RsTable")

> **components.RsTable**: `object`

#### components.RsTable.description[​](#componentsrstabledescription "Direct link to components.RsTable.description")

> **components.RsTable.description**: `string` = `"Table"`

#### components.RsTable.name[​](#componentsrstablename "Direct link to components.RsTable.name")

> **components.RsTable.name**: `string` = `"Table"`

#### components.RsTable.props[​](#componentsrstableprops "Direct link to components.RsTable.props")

> **components.RsTable.props**: `object`

#### components.RsTable.props.affixHeader[​](#componentsrstablepropsaffixheader "Direct link to components.RsTable.props.affixHeader")

> **components.RsTable.props.affixHeader**: `object`

#### components.RsTable.props.affixHeader.description[​](#componentsrstablepropsaffixheaderdescription "Direct link to components.RsTable.props.affixHeader.description")

> **components.RsTable.props.affixHeader.description**: `string` = `"Affix the table header to the specified location on the page"`

#### components.RsTable.props.affixHeader.name[​](#componentsrstablepropsaffixheadername "Direct link to components.RsTable.props.affixHeader.name")

> **components.RsTable.props.affixHeader.name**: `string` = `"Affix header"`

#### components.RsTable.props.affixHorizontalScrollbar[​](#componentsrstablepropsaffixhorizontalscrollbar "Direct link to components.RsTable.props.affixHorizontalScrollbar")

> **components.RsTable.props.affixHorizontalScrollbar**: `object`

#### components.RsTable.props.affixHorizontalScrollbar.description[​](#componentsrstablepropsaffixhorizontalscrollbardescription "Direct link to components.RsTable.props.affixHorizontalScrollbar.description")

> **components.RsTable.props.affixHorizontalScrollbar.description**: `string` = `"Affix the table horizontal scrollbar to the specified position on the page"`

#### components.RsTable.props.affixHorizontalScrollbar.name[​](#componentsrstablepropsaffixhorizontalscrollbarname "Direct link to components.RsTable.props.affixHorizontalScrollbar.name")

> **components.RsTable.props.affixHorizontalScrollbar.name**: `string` = `"Affix horizontal scrollbar"`

#### components.RsTable.props.autoHeight[​](#componentsrstablepropsautoheight "Direct link to components.RsTable.props.autoHeight")

> **components.RsTable.props.autoHeight**: `object`

#### components.RsTable.props.autoHeight.description[​](#componentsrstablepropsautoheightdescription "Direct link to components.RsTable.props.autoHeight.description")

> **components.RsTable.props.autoHeight.description**: `string` = `"The height of the table will be automatically expanded according to the number of data rows, and no vertical scroll bar will appear"`

#### components.RsTable.props.autoHeight.name[​](#componentsrstablepropsautoheightname "Direct link to components.RsTable.props.autoHeight.name")

> **components.RsTable.props.autoHeight.name**: `string` = `"Auto height"`

#### components.RsTable.props.bordered[​](#componentsrstablepropsbordered "Direct link to components.RsTable.props.bordered")

> **components.RsTable.props.bordered**: `object`

#### components.RsTable.props.bordered.description[​](#componentsrstablepropsbordereddescription "Direct link to components.RsTable.props.bordered.description")

> **components.RsTable.props.bordered.description**: `string` = `"Show border"`

#### components.RsTable.props.bordered.name[​](#componentsrstablepropsborderedname "Direct link to components.RsTable.props.bordered.name")

> **components.RsTable.props.bordered.name**: `string` = `"Bordered"`

#### components.RsTable.props.cellBordered[​](#componentsrstablepropscellbordered "Direct link to components.RsTable.props.cellBordered")

> **components.RsTable.props.cellBordered**: `object`

#### components.RsTable.props.cellBordered.description[​](#componentsrstablepropscellbordereddescription "Direct link to components.RsTable.props.cellBordered.description")

> **components.RsTable.props.cellBordered.description**: `string` = `"Show cell border"`

#### components.RsTable.props.cellBordered.name[​](#componentsrstablepropscellborderedname "Direct link to components.RsTable.props.cellBordered.name")

> **components.RsTable.props.cellBordered.name**: `string` = `"Cell bordered"`

#### components.RsTable.props.data[​](#componentsrstablepropsdata "Direct link to components.RsTable.props.data")

> **components.RsTable.props.data**: `object`

#### components.RsTable.props.data.description[​](#componentsrstablepropsdatadescription "Direct link to components.RsTable.props.data.description")

> **components.RsTable.props.data.description**: `string` = `"Table data"`

#### components.RsTable.props.data.name[​](#componentsrstablepropsdataname "Direct link to components.RsTable.props.data.name")

> **components.RsTable.props.data.name**: `string` = `"Data"`

#### components.RsTable.props.defaultSortType[​](#componentsrstablepropsdefaultsorttype "Direct link to components.RsTable.props.defaultSortType")

> **components.RsTable.props.defaultSortType**: `object`

#### components.RsTable.props.defaultSortType.description[​](#componentsrstablepropsdefaultsorttypedescription "Direct link to components.RsTable.props.defaultSortType.description")

> **components.RsTable.props.defaultSortType.description**: `string` = `"Sort type"`

#### components.RsTable.props.defaultSortType.name[​](#componentsrstablepropsdefaultsorttypename "Direct link to components.RsTable.props.defaultSortType.name")

> **components.RsTable.props.defaultSortType.name**: `string` = `"Default sort type"`

#### components.RsTable.props.fillHeight[​](#componentsrstablepropsfillheight "Direct link to components.RsTable.props.fillHeight")

> **components.RsTable.props.fillHeight**: `object`

#### components.RsTable.props.fillHeight.description[​](#componentsrstablepropsfillheightdescription "Direct link to components.RsTable.props.fillHeight.description")

> **components.RsTable.props.fillHeight.description**: `string` = `"Force the height of the table to be equal to the height of its parent container. Cannot be used together with 'Auto height'"`

#### components.RsTable.props.fillHeight.name[​](#componentsrstablepropsfillheightname "Direct link to components.RsTable.props.fillHeight.name")

> **components.RsTable.props.fillHeight.name**: `string` = `"Fill height"`

#### components.RsTable.props.headerHeight[​](#componentsrstablepropsheaderheight "Direct link to components.RsTable.props.headerHeight")

> **components.RsTable.props.headerHeight**: `object`

#### components.RsTable.props.headerHeight.description[​](#componentsrstablepropsheaderheightdescription "Direct link to components.RsTable.props.headerHeight.description")

> **components.RsTable.props.headerHeight.description**: `string` = `"Table header height"`

#### components.RsTable.props.headerHeight.name[​](#componentsrstablepropsheaderheightname "Direct link to components.RsTable.props.headerHeight.name")

> **components.RsTable.props.headerHeight.name**: `string` = `"Header height"`

#### components.RsTable.props.height[​](#componentsrstablepropsheight "Direct link to components.RsTable.props.height")

> **components.RsTable.props.height**: `object`

#### components.RsTable.props.height.description[​](#componentsrstablepropsheightdescription "Direct link to components.RsTable.props.height.description")

> **components.RsTable.props.height.description**: `string` = `"Table height"`

#### components.RsTable.props.height.name[​](#componentsrstablepropsheightname "Direct link to components.RsTable.props.height.name")

> **components.RsTable.props.height.name**: `string` = `"Height"`

#### components.RsTable.props.hover[​](#componentsrstablepropshover "Direct link to components.RsTable.props.hover")

> **components.RsTable.props.hover**: `object`

#### components.RsTable.props.hover.description[​](#componentsrstablepropshoverdescription "Direct link to components.RsTable.props.hover.description")

> **components.RsTable.props.hover.description**: `string` = `"The row of the table has a mouseover effect"`

#### components.RsTable.props.hover.name[​](#componentsrstablepropshovername "Direct link to components.RsTable.props.hover.name")

> **components.RsTable.props.hover.name**: `string` = `"Hover"`

#### components.RsTable.props.loading[​](#componentsrstablepropsloading "Direct link to components.RsTable.props.loading")

> **components.RsTable.props.loading**: `object`

#### components.RsTable.props.loading.description[​](#componentsrstablepropsloadingdescription "Direct link to components.RsTable.props.loading.description")

> **components.RsTable.props.loading.description**: `string` = `"Show loading"`

#### components.RsTable.props.loading.name[​](#componentsrstablepropsloadingname "Direct link to components.RsTable.props.loading.name")

> **components.RsTable.props.loading.name**: `string` = `"Loading"`

#### components.RsTable.props.maxHeight[​](#componentsrstablepropsmaxheight "Direct link to components.RsTable.props.maxHeight")

> **components.RsTable.props.maxHeight**: `object`

#### components.RsTable.props.maxHeight.description[​](#componentsrstablepropsmaxheightdescription "Direct link to components.RsTable.props.maxHeight.description")

> **components.RsTable.props.maxHeight.description**: `string` = `"Maximum height"`

#### components.RsTable.props.maxHeight.name[​](#componentsrstablepropsmaxheightname "Direct link to components.RsTable.props.maxHeight.name")

> **components.RsTable.props.maxHeight.name**: `string` = `"Max height"`

#### components.RsTable.props.minHeight[​](#componentsrstablepropsminheight "Direct link to components.RsTable.props.minHeight")

> **components.RsTable.props.minHeight**: `object`

#### components.RsTable.props.minHeight.description[​](#componentsrstablepropsminheightdescription "Direct link to components.RsTable.props.minHeight.description")

> **components.RsTable.props.minHeight.description**: `string` = `"Minimum height"`

#### components.RsTable.props.minHeight.name[​](#componentsrstablepropsminheightname "Direct link to components.RsTable.props.minHeight.name")

> **components.RsTable.props.minHeight.name**: `string` = `"Min height"`

#### components.RsTable.props.rowClassName[​](#componentsrstablepropsrowclassname "Direct link to components.RsTable.props.rowClassName")

> **components.RsTable.props.rowClassName**: `object`

#### components.RsTable.props.rowClassName.description[​](#componentsrstablepropsrowclassnamedescription "Direct link to components.RsTable.props.rowClassName.description")

> **components.RsTable.props.rowClassName.description**: `string` = `"Add an optional extra class name to row"`

#### components.RsTable.props.rowClassName.name[​](#componentsrstablepropsrowclassnamename "Direct link to components.RsTable.props.rowClassName.name")

> **components.RsTable.props.rowClassName.name**: `string` = `"Row class name"`

#### components.RsTable.props.rowHeight[​](#componentsrstablepropsrowheight "Direct link to components.RsTable.props.rowHeight")

> **components.RsTable.props.rowHeight**: `object`

#### components.RsTable.props.rowHeight.description[​](#componentsrstablepropsrowheightdescription "Direct link to components.RsTable.props.rowHeight.description")

> **components.RsTable.props.rowHeight.description**: `string` = `"Row height"`

#### components.RsTable.props.rowHeight.name[​](#componentsrstablepropsrowheightname "Direct link to components.RsTable.props.rowHeight.name")

> **components.RsTable.props.rowHeight.name**: `string` = `"Row height"`

#### components.RsTable.props.rowKey[​](#componentsrstablepropsrowkey "Direct link to components.RsTable.props.rowKey")

> **components.RsTable.props.rowKey**: `object`

#### components.RsTable.props.rowKey.description[​](#componentsrstablepropsrowkeydescription "Direct link to components.RsTable.props.rowKey.description")

> **components.RsTable.props.rowKey.description**: `string` = `"Each row corresponds to the unique key in data"`

#### components.RsTable.props.rowKey.name[​](#componentsrstablepropsrowkeyname "Direct link to components.RsTable.props.rowKey.name")

> **components.RsTable.props.rowKey.name**: `string` = `"Row key"`

#### components.RsTable.props.shouldUpdateScroll[​](#componentsrstablepropsshouldupdatescroll "Direct link to components.RsTable.props.shouldUpdateScroll")

> **components.RsTable.props.shouldUpdateScroll**: `object`

#### components.RsTable.props.shouldUpdateScroll.description[​](#componentsrstablepropsshouldupdatescrolldescription "Direct link to components.RsTable.props.shouldUpdateScroll.description")

> **components.RsTable.props.shouldUpdateScroll.description**: `string` = `"Whether to update the scroll after the table size is updated"`

#### components.RsTable.props.shouldUpdateScroll.name[​](#componentsrstablepropsshouldupdatescrollname "Direct link to components.RsTable.props.shouldUpdateScroll.name")

> **components.RsTable.props.shouldUpdateScroll.name**: `string` = `"Should update scroll"`

#### components.RsTable.props.showHeader[​](#componentsrstablepropsshowheader "Direct link to components.RsTable.props.showHeader")

> **components.RsTable.props.showHeader**: `object`

#### components.RsTable.props.showHeader.description[​](#componentsrstablepropsshowheaderdescription "Direct link to components.RsTable.props.showHeader.description")

> **components.RsTable.props.showHeader.description**: `string` = `"Display header"`

#### components.RsTable.props.showHeader.name[​](#componentsrstablepropsshowheadername "Direct link to components.RsTable.props.showHeader.name")

> **components.RsTable.props.showHeader.name**: `string` = `"Show header"`

#### components.RsTable.props.sortColumn[​](#componentsrstablepropssortcolumn "Direct link to components.RsTable.props.sortColumn")

> **components.RsTable.props.sortColumn**: `object`

#### components.RsTable.props.sortColumn.description[​](#componentsrstablepropssortcolumndescription "Direct link to components.RsTable.props.sortColumn.description")

> **components.RsTable.props.sortColumn.description**: `string` = `"Sort column name"`

#### components.RsTable.props.sortColumn.name[​](#componentsrstablepropssortcolumnname "Direct link to components.RsTable.props.sortColumn.name")

> **components.RsTable.props.sortColumn.name**: `string` = `"Sort column"`

#### components.RsTable.props.sortType[​](#componentsrstablepropssorttype "Direct link to components.RsTable.props.sortType")

> **components.RsTable.props.sortType**: `object`

#### components.RsTable.props.sortType.description[​](#componentsrstablepropssorttypedescription "Direct link to components.RsTable.props.sortType.description")

> **components.RsTable.props.sortType.description**: `string` = `"Sort type"`

#### components.RsTable.props.sortType.name[​](#componentsrstablepropssorttypename "Direct link to components.RsTable.props.sortType.name")

> **components.RsTable.props.sortType.name**: `string` = `"Sort type"`

#### components.RsTable.props.virtualized[​](#componentsrstablepropsvirtualized "Direct link to components.RsTable.props.virtualized")

> **components.RsTable.props.virtualized**: `object`

#### components.RsTable.props.virtualized.description[​](#componentsrstablepropsvirtualizeddescription "Direct link to components.RsTable.props.virtualized.description")

> **components.RsTable.props.virtualized.description**: `string` = `"Effectively render large tabular data"`

#### components.RsTable.props.virtualized.name[​](#componentsrstablepropsvirtualizedname "Direct link to components.RsTable.props.virtualized.name")

> **components.RsTable.props.virtualized.name**: `string` = `"Virtualized"`

#### components.RsTable.props.width[​](#componentsrstablepropswidth "Direct link to components.RsTable.props.width")

> **components.RsTable.props.width**: `object`

#### components.RsTable.props.width.description[​](#componentsrstablepropswidthdescription "Direct link to components.RsTable.props.width.description")

> **components.RsTable.props.width.description**: `string` = `"Table width"`

#### components.RsTable.props.width.name[​](#componentsrstablepropswidthname "Direct link to components.RsTable.props.width.name")

> **components.RsTable.props.width.name**: `string` = `"Width"`

#### components.RsTable.props.wordWrap[​](#componentsrstablepropswordwrap "Direct link to components.RsTable.props.wordWrap")

> **components.RsTable.props.wordWrap**: `object`

#### components.RsTable.props.wordWrap.description[​](#componentsrstablepropswordwrapdescription "Direct link to components.RsTable.props.wordWrap.description")

> **components.RsTable.props.wordWrap.description**: `string` = `"Whether to appear line breaks where text overflows its content box"`

#### components.RsTable.props.wordWrap.name[​](#componentsrstablepropswordwrapname "Direct link to components.RsTable.props.wordWrap.name")

> **components.RsTable.props.wordWrap.name**: `string` = `"Word wrap"`


---

# Variable: tableModels

> `const` **tableModels**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

An array of rSuite tables components metadata for use in FormViewer.


---

# @react-form-builder/components-rsuite

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [RsAutoCompleteProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsAutoCompleteProps)
* [RsBreadcrumbItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbItemProps)
* [RsBreadcrumbProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbProps)
* [RsCalendarProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCalendarProps)
* [RsCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCardProps)
* [RsContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsContainerProps)
* [RsDatePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDatePickerProps)
* [RsDropdownProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDropdownProps)
* [RsErrorMessageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps)
* [RsHeaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsHeaderProps)
* [RsImageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsImageProps)
* [RsInputProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsInputProps)
* [RsLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLabelProps)
* [RsLinkProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLinkProps)
* [RsMenuProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsMenuProps)
* [RsModalLayoutProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalLayoutProps)
* [RsModalProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalProps)
* [RsNumberFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsNumberFormatProps)
* [RsPatternFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsPatternFormatProps)
* [RsRadioGroupProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsRadioGroupProps)
* [RsSearchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsSearchProps)
* [RsStaticContentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsStaticContentProps)
* [RsTabProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTabProps)
* [RsTagPickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTagPickerProps)
* [RsTextAreaProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTextAreaProps)
* [RsTimePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTimePickerProps)
* [RsTooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps)
* [RsUploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsUploaderProps)
* [RsWizardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardProps)
* [RsWizardStepProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardStepProps)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

* [LoadCallback](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadCallback)
* [LoadDataHandler](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadDataHandler)
* [MenuItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/MenuItem)
* [RsTabItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/RsTabItem)

## Variables[​](#variables "Direct link to Variables")

* [builderViewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/builderViewWithCss)
* [components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/components)
* [models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/models)
* [rsAutoComplete](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsAutoComplete)
* [rsBreadcrumb](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsBreadcrumb)
* [rsButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsButton)
* [rsCalendar](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCalendar)
* [rsCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCard)
* [rsCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCheckbox)
* [rsContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsContainer)
* [rsDatePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDatePicker)
* [rsDivider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDivider)
* [rsDropdown](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDropdown)
* [rsErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsErrorMessage)
* [rsHeader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsHeader)
* [rsImage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsImage)
* [rsInput](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsInput)
* [rsLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLabel)
* [rsLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLink)
* [rsMenu](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMenu)
* [rsMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMessage)
* [rsModal](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModal)
* [rsModalLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModalLayout)
* [rsNumberFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsNumberFormat)
* [rsPatternFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPatternFormat)
* [rsPlaceholderGraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGraph)
* [rsPlaceholderGrid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGrid)
* [rsPlaceholderParagraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderParagraph)
* [rsProgressCircle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressCircle)
* [rsProgressLine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressLine)
* [rsRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsRadioGroup)
* [rsSearch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsSearch)
* [rsStaticContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsStaticContent)
* [rsTab](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTab)
* [rsTagPicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTagPicker)
* [rsTextArea](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTextArea)
* [rsTimePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTimePicker)
* [rsToggle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsToggle)
* [rsTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTooltip)
* [rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponents)
* [rSuiteComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponentsDescriptions)
* [rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteEnUsComponentsDescriptions)
* [rsUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsUploader)
* [rsWizard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizard)
* [rsWizardStep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizardStep)
* [view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/view)
* [viewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/viewWithCss)

## Functions[​](#functions "Direct link to Functions")

* [formEngineRsuiteCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/formEngineRsuiteCssLoader)
* [ltrCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/ltrCssLoader)
* [RsLocalizationWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/RsLocalizationWrapper)
* [rtlCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/rtlCssLoader)


---

# Function: formEngineRsuiteCssLoader()

> **formEngineRsuiteCssLoader**(): `Promise`<`void`>

Loads FormEngine specific styles over "rsuite" library.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`>

the Promise that resolves when the custom styles have been loaded successfully.


---

# Function: ltrCssLoader()

> **ltrCssLoader**(): `Promise`<`void`>

Loads the Left-To-Right (LTR) CSS for the "rsuite" library.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`>

the Promise that resolves when the LTR CSS has been loaded successfully.


---

# Function: RsLocalizationWrapper()

> **RsLocalizationWrapper**(`props`): `Element`

Wrapper component for RSuite components localization.

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`FormViewerWrapperComponentProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerWrapperComponentProps)

the component props.

## Returns[​](#returns "Direct link to Returns")

`Element`

the wrapped components with localization settings applied.


---

# Function: rtlCssLoader()

> **rtlCssLoader**(): `Promise`<`void`>

Loads the Right-to-Left (RTL) CSS for the "rsuite" library.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`>

the Promise that resolves when the RTL CSS has been loaded successfully.


---

# Interface: RsAutoCompleteProps

The properties of the RsAutoComplete component.

## Extends[​](#extends "Direct link to Extends")

* `AutoCompleteProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`AutoCompleteProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`AutoCompleteProps.as`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `string`

AutoComplete Content

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`AutoCompleteProps.autoComplete`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`AutoCompleteProps.block`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`AutoCompleteProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`AutoCompleteProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The component class name.

#### Overrides[​](#overrides "Direct link to Overrides")

`AutoCompleteProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`AutoCompleteProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`AutoCompleteProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`AutoCompleteProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`AutoCompleteProps.containerPadding`

***

### data[​](#data "Direct link to data")

> **data**: (`string` | `ItemDataType`<`string` | `number`>)\[]

The data of the component.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`AutoCompleteProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`AutoCompleteProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string`

Initial value

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`AutoCompleteProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`AutoCompleteProps.disabled`

***

### disabledItemValues?[​](#disableditemvalues "Direct link to disabledItemValues?")

> `optional` **disabledItemValues**: `string`\[]

Disabled items

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`AutoCompleteProps.disabledItemValues`

***

### filterBy()?[​](#filterby "Direct link to filterBy()?")

> `optional` **filterBy**: (`value`, `item`) => `boolean`

Custom filter function to determine whether the item will be displayed

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`string`

##### item[​](#item "Direct link to item")

`ItemDataType`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`AutoCompleteProps.filterBy`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`AutoCompleteProps.id`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The component label.

***

### labelKey?[​](#labelkey "Direct link to labelKey?")

> `optional` **labelKey**: `string`

The key to use for displaying the options in the data.

#### Default[​](#default-1 "Direct link to Default")

```
label
```

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`AutoCompleteProps.labelKey`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`any`>

Custom locale

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`AutoCompleteProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

The width of the menu will automatically follow the width of the input box

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`AutoCompleteProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

Additional classes for menu

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`AutoCompleteProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`AutoCompleteProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`AutoCompleteProps.menuStyle`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`AutoCompleteProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`Element`>

Called on blur

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`AutoCompleteProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`string`

the value.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`AutoCompleteProps.onChange`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called on close

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`AutoCompleteProps.onClose`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`AutoCompleteProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`AutoCompleteProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`AutoCompleteProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`AutoCompleteProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`AutoCompleteProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`AutoCompleteProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`Element`>

Called on focus

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`AutoCompleteProps.onFocus`

***

### onKeyDown()?[​](#onkeydown "Direct link to onKeyDown()?")

> `optional` **onKeyDown**: (`event`) => `void`

The callback triggered by keyboard events.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`KeyboardEvent`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`AutoCompleteProps.onKeyDown`

***

### onMenuFocus()?[​](#onmenufocus "Direct link to onMenuFocus()?")

> `optional` **onMenuFocus**: (`focusItemValue`, `event`) => `void`

Called on menu focus

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### focusItemValue[​](#focusitemvalue "Direct link to focusItemValue")

`any`

##### event[​](#event-1 "Direct link to event")

`KeyboardEvent`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`AutoCompleteProps.onMenuFocus`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called on open

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`AutoCompleteProps.onOpen`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`value`, `item`, `event`) => `void`

Called when a option is selected

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

##### item[​](#item-1 "Direct link to item")

`ItemDataType`

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`AutoCompleteProps.onSelect`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`AutoCompleteProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

Placeholder text

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`AutoCompleteProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of component

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`AutoCompleteProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`AutoCompleteProps.plaintext`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`AutoCompleteProps.preventOverflow`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`AutoCompleteProps.readOnly`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-13 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`AutoCompleteProps.renderExtraFooter`

***

### renderMenu()?[​](#rendermenu "Direct link to renderMenu()?")

> `optional` **renderMenu**: (`menu`) => `ReactNode`

Customizing the Rendering Menu list

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### menu[​](#menu "Direct link to menu")

`ReactNode`

#### Returns[​](#returns-14 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`AutoCompleteProps.renderMenu`

***

### renderMenuItem()?[​](#rendermenuitem "Direct link to renderMenuItem()?")

> `optional` **renderMenuItem**: (`label`, `item`) => `ReactNode`

Custom selected option

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### label[​](#label-1 "Direct link to label")

`ReactNode`

##### item[​](#item-2 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-15 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`AutoCompleteProps.renderMenuItem`

***

### selectOnEnter?[​](#selectonenter "Direct link to selectOnEnter?")

> `optional` **selectOnEnter**: `boolean`

When set to false, the Enter key selection function is invalid

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`AutoCompleteProps.selectOnEnter`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`AutoCompleteProps.size`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

The component styles.

#### Overrides[​](#overrides-2 "Direct link to Overrides")

`AutoCompleteProps.style`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`AutoCompleteProps.toggleAs`

***

### value?[​](#value-3 "Direct link to value?")

> `optional` **value**: `string`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`AutoCompleteProps.value`

***

### valueKey?[​](#valuekey "Direct link to valueKey?")

> `optional` **valueKey**: `string`

The key to use for setting the option value in the data.

#### Default[​](#default-2 "Direct link to Default")

```
value
```

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`AutoCompleteProps.valueKey`


---

# Interface: RsBreadcrumbItemProps

Props for a single breadcrumb item.

## Properties[​](#properties "Direct link to Properties")

### active?[​](#active "Direct link to active?")

> `optional` **active**: `boolean`

Whether the breadcrumb item is active.

***

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

URL for the breadcrumb item.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

Title text for the breadcrumb item.


---

# Interface: RsBreadcrumbProps

Props for the RsBreadcrumb component.

## Extends[​](#extends "Direct link to Extends")

* `BreadcrumbProps`

## Properties[​](#properties "Direct link to Properties")

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`BreadcrumbProps.as`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`BreadcrumbProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`BreadcrumbProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`BreadcrumbProps.classPrefix`

***

### ellipsis?[​](#ellipsis "Direct link to ellipsis?")

> `optional` **ellipsis**: `ReactNode`

The ellipsis element.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`BreadcrumbProps.ellipsis`

***

### items[​](#items "Direct link to items")

> **items**: [`RsBreadcrumbItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbItemProps)\[]

Array of breadcrumb items to display.

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `PickKeys`<{ `expandText`: `string`; }>

The locale of the component.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`BreadcrumbProps.locale`

***

### maxItems?[​](#maxitems "Direct link to maxItems?")

> `optional` **maxItems**: `number`

Set the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first and last will be shown, with an ellipsis in between.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`BreadcrumbProps.maxItems`

***

### onExpand()?[​](#onexpand "Direct link to onExpand()?")

> `optional` **onExpand**: (`event`) => `void`

Callback function for clicking the ellipsis.

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`MouseEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`BreadcrumbProps.onExpand`

***

### onItemClick()[​](#onitemclick "Direct link to onItemClick()")

> **onItemClick**: (`item`) => `void`

Callback function when a breadcrumb item is clicked.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### item[​](#item "Direct link to item")

[`RsBreadcrumbItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbItemProps)

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### separator?[​](#separator "Direct link to separator?")

> `optional` **separator**: `ReactNode`

The separator between each breadcrumb item.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`BreadcrumbProps.separator`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`BreadcrumbProps.style`


---

# Interface: RsCalendarProps

Props for the RsCalendar component.

## Extends[​](#extends "Direct link to Extends")

* `CalendarProps`

## Properties[​](#properties "Direct link to Properties")

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`CalendarProps.as`

***

### bordered?[​](#bordered "Direct link to bordered?")

> `optional` **bordered**: `boolean`

Show border

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`CalendarProps.bordered`

***

### cellClassName()?[​](#cellclassname "Direct link to cellClassName()?")

> `optional` **cellClassName**: (`date`) => `undefined` | `string`

Custom cell classes base on it's date

#### Parameters[​](#parameters "Direct link to Parameters")

##### date[​](#date "Direct link to date")

`Date`

#### Returns[​](#returns "Direct link to Returns")

`undefined` | `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`CalendarProps.cellClassName`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`CalendarProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`CalendarProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`CalendarProps.classPrefix`

***

### compact?[​](#compact "Direct link to compact?")

> `optional` **compact**: `boolean`

Display a compact calendar

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`CalendarProps.compact`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `Date`

Default value

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`CalendarProps.defaultValue`

***

### isoWeek?[​](#isoweek "Direct link to isoWeek?")

> `optional` **isoWeek**: `boolean`

ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day

#### See[​](#see "Direct link to See")

<https://en.wikipedia.org/wiki/ISO_week_date>

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`CalendarProps.isoWeek`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

Label for the calendar.

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `CalendarLocale`

Custom locale object

#### See[​](#see-1 "Direct link to See")

<https://rsuitejs.com/guide/i18n/#calendar>

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`CalendarProps.locale`

***

### monthDropdownProps?[​](#monthdropdownprops "Direct link to monthDropdownProps?")

> `optional` **monthDropdownProps**: `MonthDropdownProps`

The props for the Month Dropdown component.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`CalendarProps.monthDropdownProps`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`date`) => `void`

Callback fired before the value changed

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### date[​](#date-1 "Direct link to date")

`Date`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`CalendarProps.onChange`

***

### onMonthChange()?[​](#onmonthchange "Direct link to onMonthChange()?")

> `optional` **onMonthChange**: (`date`) => `void`

Callback fired before the month changed @todo-Doma Change signature to `onMonthChange(year: number, month: number, reason: string)`?

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### date[​](#date-2 "Direct link to date")

`Date`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`CalendarProps.onMonthChange`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`date`) => `void`

Callback fired before the date selected

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### date[​](#date-3 "Direct link to date")

`Date`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`CalendarProps.onSelect`

***

### readOnly[​](#readonly "Direct link to readOnly")

> **readOnly**: `boolean`

Whether the calendar is read only.

***

### renderCell()?[​](#rendercell "Direct link to renderCell()?")

> `optional` **renderCell**: (`date`) => `ReactNode`

Custom render calendar cells

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### date[​](#date-4 "Direct link to date")

`Date`

#### Returns[​](#returns-4 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`CalendarProps.renderCell`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`CalendarProps.style`

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `Date`

Controlled value

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`CalendarProps.value`

***

### weekStart?[​](#weekstart "Direct link to weekStart?")

> `optional` **weekStart**: `0` | `3` | `1` | `2` | `4` | `5` | `6`

The index of the first day of the week (0 - Sunday) If `isoWeek` is `true`, the value of `weekStart` is ignored.

#### Default[​](#default "Direct link to Default")

```
0
```

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`CalendarProps.weekStart`


---

# Interface: RsCardProps

Props for the RsCard component.

## Extends[​](#extends "Direct link to Extends")

* `PanelProps`

## Properties[​](#properties "Direct link to Properties")

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`PanelProps.as`

***

### bodyFill?[​](#bodyfill "Direct link to bodyFill?")

> `optional` **bodyFill**: `boolean`

Content area filled with containers

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`PanelProps.bodyFill`

***

### bodyProps?[​](#bodyprops "Direct link to bodyProps?")

> `optional` **bodyProps**: `HTMLAttributes`<`HTMLDivElement`>

Custom body style

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`PanelProps.bodyProps`

***

### bordered?[​](#bordered "Direct link to bordered?")

> `optional` **bordered**: `boolean`

Show border

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`PanelProps.bordered`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

The icon on the right side of the title

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`PanelProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`PanelProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`PanelProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`PanelProps.classPrefix`

***

### collapsible?[​](#collapsible "Direct link to collapsible?")

> `optional` **collapsible**: `boolean`

Whether it is a collapsible panel

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`PanelProps.collapsible`

***

### defaultExpanded?[​](#defaultexpanded "Direct link to defaultExpanded?")

> `optional` **defaultExpanded**: `boolean`

Expand then panel by default

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`PanelProps.defaultExpanded`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Whether the panel is disabled

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`PanelProps.disabled`

***

### eventKey?[​](#eventkey "Direct link to eventKey?")

> `optional` **eventKey**: `string` | `number`

The event key corresponding to the panel

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`PanelProps.eventKey`

***

### expanded?[​](#expanded "Direct link to expanded?")

> `optional` **expanded**: `boolean`

Expand then panel

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`PanelProps.expanded`

***

### header?[​](#header "Direct link to header?")

> `optional` **header**: `ReactNode`

The head displays information

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`PanelProps.header`

***

### headerRole?[​](#headerrole "Direct link to headerRole?")

> `optional` **headerRole**: `string`

The role attribute of the header

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`PanelProps.headerRole`

***

### headerSize[​](#headersize "Direct link to headerSize")

> **headerSize**: `string`

Header size for the card.

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The id attribute of the panel

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`PanelProps.id`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`PanelProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`PanelProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`PanelProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`PanelProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`PanelProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`PanelProps.onExiting`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`eventKey`, `event`) => `void`

Called when the panel is selected

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### eventKey[​](#eventkey-1 "Direct link to eventKey")

`undefined` | `string` | `number`

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`PanelProps.onSelect`

***

### panelRole?[​](#panelrole "Direct link to panelRole?")

> `optional` **panelRole**: `string`

The role attribute of the panel

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`PanelProps.panelRole`

***

### scrollShadow?[​](#scrollshadow "Direct link to scrollShadow?")

> `optional` **scrollShadow**: `boolean`

The shadow of the content when scrolling

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`PanelProps.scrollShadow`

***

### shaded?[​](#shaded "Direct link to shaded?")

> `optional` **shaded**: `boolean`

Whether there is a shadow

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`PanelProps.shaded`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`PanelProps.style`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

Title for the card.


---

# Interface: RsContainerProps

Props for the RsContainer component.

## Properties[​](#properties "Direct link to Properties")

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Children elements of the container.

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Whether the container is disabled.

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Whether the container is read only.


---

# Interface: RsDatePickerProps

Props for the RsDatePicker component.

## Extends[​](#extends "Direct link to Extends")

* `DatePickerProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`DatePickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`DatePickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`DatePickerProps.block`

***

### calendarDefaultDate?[​](#calendardefaultdate "Direct link to calendarDefaultDate?")

> `optional` **calendarDefaultDate**: `Date`

Calendar panel default presentation date and time

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`DatePickerProps.calendarDefaultDate`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `null` | `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`DatePickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`DatePickerProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`DatePickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`DatePickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`DatePickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`DatePickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`DatePickerProps.containerPadding`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`DatePickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `null` | `Date`

Initial value

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`DatePickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Whether disabled the component

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`DatePickerProps.disabled`

***

### ~~disabledDate()?~~[​](#disableddate "Direct link to disableddate")

> `optional` **disabledDate**: (`date?`) => `boolean`

Whether to disable a date on the calendar view

#### Parameters[​](#parameters "Direct link to Parameters")

##### date?[​](#date "Direct link to date?")

`Date`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

date should be disabled (not selectable)

#### Deprecated[​](#deprecated "Direct link to Deprecated")

Use [shouldDisableDate](#shoulddisabledate) instead

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`DatePickerProps.disabledDate`

***

### ~~disabledHours()?~~[​](#disabledhours "Direct link to disabledhours")

> `optional` **disabledHours**: (`hour`, `date`) => `boolean`

Disabled hours

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### hour[​](#hour "Direct link to hour")

`number`

##### date[​](#date-1 "Direct link to date")

`Date`

#### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

Use [shouldDisableHour](#shoulddisablehour) instead

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`DatePickerProps.disabledHours`

***

### ~~disabledMinutes()?~~[​](#disabledminutes "Direct link to disabledminutes")

> `optional` **disabledMinutes**: (`minute`, `date`) => `boolean`

Disabled minutes

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### minute[​](#minute "Direct link to minute")

`number`

##### date[​](#date-2 "Direct link to date")

`Date`

#### Returns[​](#returns-2 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use [shouldDisableMinute](#shoulddisableminute) instead

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`DatePickerProps.disabledMinutes`

***

### ~~disabledSeconds()?~~[​](#disabledseconds "Direct link to disabledseconds")

> `optional` **disabledSeconds**: (`second`, `date`) => `boolean`

Disabled seconds

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### second[​](#second "Direct link to second")

`number`

##### date[​](#date-3 "Direct link to date")

`Date`

#### Returns[​](#returns-3 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use [shouldDisableSecond](#shoulddisablesecond) instead

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`DatePickerProps.disabledSeconds`

***

### editable?[​](#editable "Direct link to editable?")

> `optional` **editable**: `boolean`

Rendered as an input, the date can be entered via the keyboard

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`DatePickerProps.editable`

***

### format?[​](#format "Direct link to format?")

> `optional` **format**: `string`

Format date string

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`DatePickerProps.format`

***

### hideHours()?[​](#hidehours "Direct link to hideHours()?")

> `optional` **hideHours**: (`hour`, `date`) => `boolean`

Hide specific hour options

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hour[​](#hour-1 "Direct link to hour")

`number`

##### date[​](#date-4 "Direct link to date")

`Date`

#### Returns[​](#returns-4 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`DatePickerProps.hideHours`

***

### hideMinutes()?[​](#hideminutes "Direct link to hideMinutes()?")

> `optional` **hideMinutes**: (`minute`, `date`) => `boolean`

Hide specific minute options

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### minute[​](#minute-1 "Direct link to minute")

`number`

##### date[​](#date-5 "Direct link to date")

`Date`

#### Returns[​](#returns-5 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`DatePickerProps.hideMinutes`

***

### hideSeconds()?[​](#hideseconds "Direct link to hideSeconds()?")

> `optional` **hideSeconds**: (`second`, `date`) => `boolean`

Hide specific second options

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### second[​](#second-1 "Direct link to second")

`number`

##### date[​](#date-6 "Direct link to date")

`Date`

#### Returns[​](#returns-6 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`DatePickerProps.hideSeconds`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`DatePickerProps.id`

***

### ~~inline?~~[​](#inline "Direct link to inline")

> `optional` **inline**: `boolean`

#### Deprecated[​](#deprecated-4 "Direct link to Deprecated")

#### Overrides[​](#overrides "Direct link to Overrides")

`DatePickerProps.inline`

***

### isoWeek?[​](#isoweek "Direct link to isoWeek?")

> `optional` **isoWeek**: `boolean`

ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day

#### See[​](#see "Direct link to See")

<https://en.wikipedia.org/wiki/ISO_week_date>

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`DatePickerProps.isoWeek`

***

### label[​](#label "Direct link to label")

> **label**: `string`

Label for the date picker.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`DatePickerProps.label`

***

### limitEndYear?[​](#limitendyear "Direct link to limitEndYear?")

> `optional` **limitEndYear**: `number`

Set the upper limit of the available year relative to the current selection date

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`DatePickerProps.limitEndYear`

***

### limitStartYear?[​](#limitstartyear "Direct link to limitStartYear?")

> `optional` **limitStartYear**: `number`

Set the lower limit of the available year relative to the current selection date

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`DatePickerProps.limitStartYear`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display a loading state indicator

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`DatePickerProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`DatePickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`DatePickerProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`DatePickerProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`DatePickerProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`DatePickerProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`DatePickerProps.menuStyle`

***

### monthDropdownProps?[​](#monthdropdownprops "Direct link to monthDropdownProps?")

> `optional` **monthDropdownProps**: `MonthDropdownProps`

The props for the Month Dropdown component.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`DatePickerProps.monthDropdownProps`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`DatePickerProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`any`>

Called when the component is blurred.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`DatePickerProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

the value.

`null` | `Date`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-2 "Direct link to Overrides")

`DatePickerProps.onChange`

***

### onChangeCalendarDate()?[​](#onchangecalendardate "Direct link to onChangeCalendarDate()?")

> `optional` **onChangeCalendarDate**: (`date`, `event?`) => `void`

Called when the calendar panel date changes

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### date[​](#date-7 "Direct link to date")

`Date`

##### event?[​](#event "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`DatePickerProps.onChangeCalendarDate`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-1 "Direct link to event")

`MouseEvent`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`DatePickerProps.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`DatePickerProps.onClose`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`DatePickerProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`DatePickerProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`DatePickerProps.onEntering`

***

### oneTap?[​](#onetap "Direct link to oneTap?")

> `optional` **oneTap**: `boolean`

One-click selection date

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`DatePickerProps.oneTap`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-14 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`DatePickerProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-15 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`DatePickerProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-16 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`DatePickerProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`any`>

Called when the component is focused.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`DatePickerProps.onFocus`

***

### onNextMonth()?[​](#onnextmonth "Direct link to onNextMonth()?")

> `optional` **onNextMonth**: (`date`) => `void`

Called after the next month

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### date[​](#date-8 "Direct link to date")

`Date`

#### Returns[​](#returns-17 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`DatePickerProps.onNextMonth`

***

### onOk()?[​](#onok "Direct link to onOk()?")

> `optional` **onOk**: (`date`, `event`) => `void`

Called after clicking the OK button

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### date[​](#date-9 "Direct link to date")

`Date`

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-18 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`DatePickerProps.onOk`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-19 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`DatePickerProps.onOpen`

***

### onPrevMonth()?[​](#onprevmonth "Direct link to onPrevMonth()?")

> `optional` **onPrevMonth**: (`date`) => `void`

Called after the prev month

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### date[​](#date-10 "Direct link to date")

`Date`

#### Returns[​](#returns-20 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`DatePickerProps.onPrevMonth`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`date`, `event?`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-19 "Direct link to Parameters")

##### date[​](#date-11 "Direct link to date")

`Date`

##### event?[​](#event-3 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-21 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`DatePickerProps.onSelect`

***

### onShortcutClick()?[​](#onshortcutclick "Direct link to onShortcutClick()?")

> `optional` **onShortcutClick**: (`range`, `event`) => `void`

Called after clicking the shortcut button

#### Parameters[​](#parameters-20 "Direct link to Parameters")

##### range[​](#range "Direct link to range")

`RangeType`<`Date`>

##### event[​](#event-4 "Direct link to event")

`MouseEvent`

#### Returns[​](#returns-22 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`DatePickerProps.onShortcutClick`

***

### onToggleMonthDropdown()?[​](#ontogglemonthdropdown "Direct link to onToggleMonthDropdown()?")

> `optional` **onToggleMonthDropdown**: (`toggle`) => `void`

Called when opening the month view

#### Parameters[​](#parameters-21 "Direct link to Parameters")

##### toggle[​](#toggle "Direct link to toggle")

`boolean`

#### Returns[​](#returns-23 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`DatePickerProps.onToggleMonthDropdown`

***

### onToggleTimeDropdown()?[​](#ontoggletimedropdown "Direct link to onToggleTimeDropdown()?")

> `optional` **onToggleTimeDropdown**: (`toggle`) => `void`

Called when opening the time view

#### Parameters[​](#parameters-22 "Direct link to Parameters")

##### toggle[​](#toggle-1 "Direct link to toggle")

`boolean`

#### Returns[​](#returns-24 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`DatePickerProps.onToggleTimeDropdown`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`DatePickerProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`DatePickerProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`DatePickerProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Whether plaintext the component

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`DatePickerProps.plaintext`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`DatePickerProps.preventOverflow`

***

### ranges?[​](#ranges "Direct link to ranges?")

> `optional` **ranges**: `RangeType`<`Date`>\[]

Predefined date Ranges

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`DatePickerProps.ranges`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Whether read only the component

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`DatePickerProps.readOnly`

***

### renderCell()?[​](#rendercell "Direct link to renderCell()?")

> `optional` **renderCell**: (`date`) => `ReactNode`

Custom rendering calendar cell content.

#### Parameters[​](#parameters-23 "Direct link to Parameters")

##### date[​](#date-12 "Direct link to date")

`Date`

#### Returns[​](#returns-25 "Direct link to Returns")

`ReactNode`

#### Version[​](#version "Direct link to Version")

5.54.0

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`DatePickerProps.renderCell`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-26 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`DatePickerProps.renderExtraFooter`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`, `format`) => `string`

Custom rendering of the selected date.

#### Parameters[​](#parameters-24 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`Date`

##### format[​](#format-1 "Direct link to format")

`string`

#### Returns[​](#returns-27 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`DatePickerProps.renderValue`

***

### shouldDisableDate()?[​](#shoulddisabledate "Direct link to shouldDisableDate()?")

> `optional` **shouldDisableDate**: (`date`) => `boolean`

Whether a date on the calendar view should be disabled

#### Parameters[​](#parameters-25 "Direct link to Parameters")

##### date[​](#date-13 "Direct link to date")

`Date`

#### Returns[​](#returns-28 "Direct link to Returns")

`boolean`

date should be disabled (not selectable)

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`DatePickerProps.shouldDisableDate`

***

### shouldDisableHour()?[​](#shoulddisablehour "Direct link to shouldDisableHour()?")

> `optional` **shouldDisableHour**: (`hour`, `date`) => `boolean`

Disabled hours on the time view

#### Parameters[​](#parameters-26 "Direct link to Parameters")

##### hour[​](#hour-2 "Direct link to hour")

`number`

##### date[​](#date-14 "Direct link to date")

`Date`

#### Returns[​](#returns-29 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`DatePickerProps.shouldDisableHour`

***

### shouldDisableMinute()?[​](#shoulddisableminute "Direct link to shouldDisableMinute()?")

> `optional` **shouldDisableMinute**: (`minute`, `date`) => `boolean`

Disabled minutes on the time view

#### Parameters[​](#parameters-27 "Direct link to Parameters")

##### minute[​](#minute-2 "Direct link to minute")

`number`

##### date[​](#date-15 "Direct link to date")

`Date`

#### Returns[​](#returns-30 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`DatePickerProps.shouldDisableMinute`

***

### shouldDisableSecond()?[​](#shoulddisablesecond "Direct link to shouldDisableSecond()?")

> `optional` **shouldDisableSecond**: (`second`, `date`) => `boolean`

Disabled seconds on the time view

#### Parameters[​](#parameters-28 "Direct link to Parameters")

##### second[​](#second-2 "Direct link to second")

`number`

##### date[​](#date-16 "Direct link to date")

`Date`

#### Returns[​](#returns-31 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`DatePickerProps.shouldDisableSecond`

***

### ~~showMeridian?~~[​](#showmeridian "Direct link to showmeridian")

> `optional` **showMeridian**: `boolean`

#### Deprecated[​](#deprecated-5 "Direct link to Deprecated")

Use `showMeridiem` instead

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`DatePickerProps.showMeridian`

***

### showMeridiem?[​](#showmeridiem "Direct link to showMeridiem?")

> `optional` **showMeridiem**: `boolean`

Meridiem format for 12-hour time

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`DatePickerProps.showMeridiem`

***

### showWeekNumbers?[​](#showweeknumbers "Direct link to showWeekNumbers?")

> `optional` **showWeekNumbers**: `boolean`

Whether to show week numbers

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`DatePickerProps.showWeekNumbers`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`DatePickerProps.size`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`DatePickerProps.style`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`DatePickerProps.toggleAs`

***

### value?[​](#value-2 "Direct link to value?")

> `optional` **value**: `null` | `Date`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`DatePickerProps.value`

***

### weekStart?[​](#weekstart "Direct link to weekStart?")

> `optional` **weekStart**: `0` | `3` | `1` | `2` | `4` | `5` | `6`

The index of the first day of the week (0 - Sunday) If `isoWeek` is `true`, the value of `weekStart` is ignored.

#### Default[​](#default "Direct link to Default")

```
0
```

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`DatePickerProps.weekStart`


---

# Interface: RsDropdownProps

Props for the RsDropdown component.

## Extends[​](#extends "Direct link to Extends")

* `InputPickerProps`.`LoadDataProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`InputPickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`InputPickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`InputPickerProps.block`

***

### cacheData?[​](#cachedata "Direct link to cacheData?")

> `optional` **cacheData**: `InputItemDataType`<`any`>\[]

Option to cache value when searching asynchronously

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`InputPickerProps.cacheData`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`InputPickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`InputPickerProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`InputPickerProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`InputPickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`InputPickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`InputPickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`InputPickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`InputPickerProps.containerPadding`

***

### creatable?[​](#creatable "Direct link to creatable?")

> `optional` **creatable**: `boolean`

Settings can create new options

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`InputPickerProps.creatable`

***

### data[​](#data "Direct link to data")

> **data**: `InputItemDataType`<`string` | `number`>\[]

The data of the component.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`InputPickerProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`InputPickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `any`

Initial value

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`InputPickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`InputPickerProps.disabled`

***

### disabledItemValues?[​](#disableditemvalues "Direct link to disabledItemValues?")

> `optional` **disabledItemValues**: `any`

Disabled items

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`InputPickerProps.disabledItemValues`

***

### disableVirtualized?[​](#disablevirtualized "Direct link to disableVirtualized?")

> `optional` **disableVirtualized**: `boolean`

Flag, if true, the virtualized will be disabled, false otherwise.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`LoadDataProps.disableVirtualized`

***

### groupBy?[​](#groupby "Direct link to groupBy?")

> `optional` **groupBy**: `string`

Set group condition key in data

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`InputPickerProps.groupBy`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`InputPickerProps.id`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the dropdown.

***

### labelKey?[​](#labelkey "Direct link to labelKey?")

> `optional` **labelKey**: `string`

The key to use for displaying the options in the data.

#### Default[​](#default-1 "Direct link to Default")

```
label
```

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`InputPickerProps.labelKey`

***

### listProps?[​](#listprops "Direct link to listProps?")

> `optional` **listProps**: `Partial`<`ListProps`<`any`>>

Virtualized List Props

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`InputPickerProps.listProps`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display an loading indicator on toggle button

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`InputPickerProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`InputPickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`InputPickerProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`InputPickerProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`InputPickerProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`InputPickerProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`InputPickerProps.menuStyle`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`InputPickerProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`Element`>

The `onBlur` attribute for the `input` element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`InputPickerProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the value.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides "Direct link to Overrides")

`InputPickerProps.onChange`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`InputPickerProps.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`InputPickerProps.onClose`

***

### onCreate()?[​](#oncreate "Direct link to onCreate()?")

> `optional` **onCreate**: (`value`, `item`, `event`) => `void`

Called when the option is created

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`any`

##### item[​](#item "Direct link to item")

`ItemDataType`

##### event[​](#event-1 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`InputPickerProps.onCreate`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`InputPickerProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`InputPickerProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`InputPickerProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`InputPickerProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`InputPickerProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`InputPickerProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`Element`>

The `onFocus` attribute for the `input` element.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`InputPickerProps.onFocus`

***

### onGroupTitleClick()?[​](#ongrouptitleclick "Direct link to onGroupTitleClick()?")

> `optional` **onGroupTitleClick**: (`event`) => `void`

Called after clicking the group title

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`InputPickerProps.onGroupTitleClick`

***

### onLoadData?[​](#onloaddata "Direct link to onLoadData?")

> `optional` **onLoadData**: [`LoadDataHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadDataHandler)

The callback function called when data should be load.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`LoadDataProps.onLoadData`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`InputPickerProps.onOpen`

***

### onSearch()?[​](#onsearch "Direct link to onSearch()?")

> `optional` **onSearch**: (`searchKeyword`, `event?`) => `void`

Called when searching

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword "Direct link to searchKeyword")

`string`

##### event?[​](#event-3 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`InputPickerProps.onSearch`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`value`, `item`, `event`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

##### item[​](#item-1 "Direct link to item")

`ItemDataType`<`any`>

##### event[​](#event-4 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`InputPickerProps.onSelect`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`InputPickerProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`InputPickerProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`InputPickerProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`InputPickerProps.plaintext`

***

### preload?[​](#preload "Direct link to preload?")

> `optional` **preload**: `boolean`

Flag, if true, the data will be loaded in advance, before opening the dropdown, false otherwise.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`LoadDataProps.preload`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`InputPickerProps.preventOverflow`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`InputPickerProps.readOnly`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-14 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`InputPickerProps.renderExtraFooter`

***

### renderMenu()?[​](#rendermenu "Direct link to renderMenu()?")

> `optional` **renderMenu**: (`menu`) => `ReactNode`

Customizing the Rendering Menu list

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### menu[​](#menu "Direct link to menu")

`ReactNode`

#### Returns[​](#returns-15 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`InputPickerProps.renderMenu`

***

### renderMenuGroup()?[​](#rendermenugroup "Direct link to renderMenuGroup()?")

> `optional` **renderMenuGroup**: (`title`, `item`) => `ReactNode`

Custom render menu group

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### title[​](#title "Direct link to title")

`ReactNode`

##### item[​](#item-2 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-16 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`InputPickerProps.renderMenuGroup`

***

### renderMenuItem()?[​](#rendermenuitem "Direct link to renderMenuItem()?")

> `optional` **renderMenuItem**: (`label`, `item`) => `ReactNode`

Custom render menuItems

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### label[​](#label-1 "Direct link to label")

`ReactNode`

##### item[​](#item-3 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-17 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`InputPickerProps.renderMenuItem`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`, `item`, `selectedElement`) => `ReactNode`

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

`any`

##### item[​](#item-4 "Direct link to item")

`ItemDataType`<`any`>

##### selectedElement[​](#selectedelement "Direct link to selectedElement")

`ReactNode`

#### Returns[​](#returns-18 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`InputPickerProps.renderValue`

***

### searchable?[​](#searchable "Direct link to searchable?")

> `optional` **searchable**: `boolean`

Whether dispaly search input box

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`InputPickerProps.searchable`

***

### searchBy()?[​](#searchby "Direct link to searchBy()?")

> `optional` **searchBy**: (`keyword`, `label`, `item`) => `boolean`

Custom search rules.

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### keyword[​](#keyword "Direct link to keyword")

`string`

##### label[​](#label-2 "Direct link to label")

`ReactNode`

##### item[​](#item-5 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-19 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`InputPickerProps.searchBy`

***

### shouldDisplayCreateOption()?[​](#shoulddisplaycreateoption "Direct link to shouldDisplayCreateOption()?")

> `optional` **shouldDisplayCreateOption**: (`searchKeyword`, `filteredData`) => `boolean`

Customize whether to display "Create option" action with given textbox value

By default, InputPicker hides "Create option" action when textbox value matches any filtered item's \[valueKey] property

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword-1 "Direct link to searchKeyword")

`string`

Value of the textbox

##### filteredData[​](#filtereddata "Direct link to filteredData")

`InputItemDataType`<`any`>\[]

The items filtered by the searchKeyword

#### Returns[​](#returns-20 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`InputPickerProps.shouldDisplayCreateOption`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`InputPickerProps.size`

***

### sort()?[​](#sort "Direct link to sort()?")

> `optional` **sort**: (`isGroup`) => (`a`, `b`) => `number`

Sort options

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### isGroup[​](#isgroup "Direct link to isGroup")

`boolean`

#### Returns[​](#returns-21 "Direct link to Returns")

> (`a`, `b`): `number`

##### Parameters[​](#parameters-19 "Direct link to Parameters")

###### a[​](#a "Direct link to a")

`any`

###### b[​](#b "Direct link to b")

`any`

##### Returns[​](#returns-22 "Direct link to Returns")

`number`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`InputPickerProps.sort`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`InputPickerProps.style`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`InputPickerProps.tabIndex`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`InputPickerProps.toggleAs`

***

### value?[​](#value-4 "Direct link to value?")

> `optional` **value**: `any`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`InputPickerProps.value`

***

### valueKey?[​](#valuekey "Direct link to valueKey?")

> `optional` **valueKey**: `string`

The key to use for setting the option value in the data.

#### Default[​](#default-2 "Direct link to Default")

```
value
```

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`InputPickerProps.valueKey`

***

### virtualized?[​](#virtualized "Direct link to virtualized?")

> `optional` **virtualized**: `boolean`

Whether using virtualized list

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`InputPickerProps.virtualized`


---

# Interface: RsErrorMessageProps

The properties of RsErrorMessage component.

## Extends[​](#extends "Direct link to Extends")

* [`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)

## Properties[​](#properties "Direct link to Properties")

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The wrapped component.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps).[`children`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps#children)

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps).[`className`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps#classname)

***

### error?[​](#error "Direct link to error?")

> `optional` **error**: `string`

The error text.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps).[`error`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps#error)

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement8`

The placement of an error message.


---

# Interface: RsHeaderProps

Props for the RsHeader component.

## Extends[​](#extends "Direct link to Extends")

* `TextProps`

## Properties[​](#properties "Direct link to Properties")

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `string`

The text alignment.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`TextProps.alignment`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`TextProps.backgroundColor`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

The color.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TextProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

The content of the header.

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `number`

The font size.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`TextProps.fontSize`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `string`

The font weight.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`TextProps.fontWeight`

***

### headerSize[​](#headersize "Direct link to headerSize")

> **headerSize**: `string`

The size of the header.


---

# Interface: RsImageProps

Props for the RsImage component.

## Extends[​](#extends "Direct link to Extends")

* `ComponentProps`<`"img"`>.`AreaProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ComponentProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ComponentProps.accessKey`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ComponentProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ComponentProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ComponentProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ComponentProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ComponentProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ComponentProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ComponentProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ComponentProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ComponentProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ComponentProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ComponentProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ComponentProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ComponentProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ComponentProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ComponentProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ComponentProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ComponentProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ComponentProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ComponentProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ComponentProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ComponentProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ComponentProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ComponentProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ComponentProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ComponentProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ComponentProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ComponentProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ComponentProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ComponentProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ComponentProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ComponentProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ComponentProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ComponentProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ComponentProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ComponentProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ComponentProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ComponentProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ComponentProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ComponentProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ComponentProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`ComponentProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`ComponentProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`ComponentProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`ComponentProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`ComponentProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`ComponentProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`ComponentProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`ComponentProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`ComponentProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`ComponentProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`ComponentProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`ComponentProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`ComponentProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`ComponentProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`ComponentProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`ComponentProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`ComponentProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`ComponentProps.autoSave`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`AreaProps.backgroundColor`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`ComponentProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`ComponentProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`ComponentProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`ComponentProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`ComponentProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`ComponentProps.contextMenu`

***

### crossOrigin?[​](#crossorigin "Direct link to crossOrigin?")

> `optional` **crossOrigin**: `CrossOrigin`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`ComponentProps.crossOrigin`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`ComponentProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`ComponentProps.datatype`

***

### decoding?[​](#decoding "Direct link to decoding?")

> `optional` **decoding**: `"async"` | `"auto"` | `"sync"`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`ComponentProps.decoding`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`ComponentProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`ComponentProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`ComponentProps.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`ComponentProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`ComponentProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`ComponentProps.exportparts`

***

### fetchPriority?[​](#fetchpriority "Direct link to fetchPriority?")

> `optional` **fetchPriority**: `"auto"` | `"high"` | `"low"`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`ComponentProps.fetchPriority`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`ComponentProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`ComponentProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`ComponentProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`ComponentProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`ComponentProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`ComponentProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`ComponentProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`ComponentProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`ComponentProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`ComponentProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`ComponentProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`ComponentProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`ComponentProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`ComponentProps.lang`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `"lazy"` | `"eager"`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`ComponentProps.loading`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`ComponentProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`ComponentProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`ComponentProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`ComponentProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`ComponentProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`ComponentProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`ComponentProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`ComponentProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`ComponentProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`ComponentProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`ComponentProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`ComponentProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`ComponentProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`ComponentProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`ComponentProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`ComponentProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`ComponentProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`ComponentProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`ComponentProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`ComponentProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`ComponentProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`ComponentProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`ComponentProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`ComponentProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`ComponentProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`ComponentProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`ComponentProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`ComponentProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`ComponentProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`ComponentProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`ComponentProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`ComponentProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`ComponentProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`ComponentProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`ComponentProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`ComponentProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`ComponentProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`ComponentProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`ComponentProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`ComponentProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`ComponentProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`ComponentProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`ComponentProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`ComponentProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`ComponentProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`ComponentProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`ComponentProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`ComponentProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`ComponentProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`ComponentProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`ComponentProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`ComponentProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`ComponentProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`ComponentProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`ComponentProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`ComponentProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`ComponentProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`ComponentProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`ComponentProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`ComponentProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`ComponentProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`ComponentProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`ComponentProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`ComponentProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`ComponentProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`ComponentProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`ComponentProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`ComponentProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`ComponentProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`ComponentProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`ComponentProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`ComponentProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`ComponentProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`ComponentProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`ComponentProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`ComponentProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`ComponentProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`ComponentProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`ComponentProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`ComponentProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`ComponentProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`ComponentProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`ComponentProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`ComponentProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`ComponentProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`ComponentProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`ComponentProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`ComponentProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`ComponentProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`ComponentProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`ComponentProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`ComponentProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`ComponentProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`ComponentProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`ComponentProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`ComponentProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`ComponentProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`ComponentProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`ComponentProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`ComponentProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`ComponentProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`ComponentProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`ComponentProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`ComponentProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`ComponentProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`ComponentProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`ComponentProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`ComponentProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`ComponentProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`ComponentProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`ComponentProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`ComponentProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`ComponentProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`ComponentProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`ComponentProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`ComponentProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`ComponentProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`ComponentProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`ComponentProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`ComponentProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`ComponentProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`ComponentProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`ComponentProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`ComponentProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`ComponentProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`ComponentProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`ComponentProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`ComponentProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`ComponentProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`ComponentProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`ComponentProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`ComponentProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`ComponentProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`ComponentProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`ComponentProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`ComponentProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`ComponentProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`ComponentProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`ComponentProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`ComponentProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`ComponentProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`ComponentProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`ComponentProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`ComponentProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`ComponentProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`ComponentProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`ComponentProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`ComponentProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`ComponentProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`ComponentProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`ComponentProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`ComponentProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`ComponentProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`ComponentProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`ComponentProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`ComponentProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`ComponentProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`ComponentProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`ComponentProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`ComponentProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`ComponentProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`ComponentProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`ComponentProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`ComponentProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`ComponentProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`ComponentProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`ComponentProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`ComponentProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`ComponentProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`ComponentProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ComponentProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`ComponentProps.radioGroup`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLImageElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`ComponentProps.ref`

***

### referrerPolicy?[​](#referrerpolicy "Direct link to referrerPolicy?")

> `optional` **referrerPolicy**: `HTMLAttributeReferrerPolicy`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ComponentProps.referrerPolicy`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`ComponentProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`ComponentProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`ComponentProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`ComponentProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`ComponentProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`ComponentProps.security`

***

### sizes?[​](#sizes "Direct link to sizes?")

> `optional` **sizes**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`ComponentProps.sizes`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`ComponentProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`ComponentProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`ComponentProps.src`

***

### srcSet?[​](#srcset "Direct link to srcSet?")

> `optional` **srcSet**: `string`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`ComponentProps.srcSet`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`ComponentProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`ComponentProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`ComponentProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`ComponentProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`ComponentProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`ComponentProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`ComponentProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`ComponentProps.unselectable`

***

### useMap?[​](#usemap "Direct link to useMap?")

> `optional` **useMap**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`ComponentProps.useMap`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`ComponentProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`ComponentProps.width`


---

# Interface: RsInputProps

Props for the RsInput component.

## Extends[​](#extends "Direct link to Extends")

* `InputProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`InputProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`InputProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`InputProps.accessKey`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`InputProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`InputProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`InputProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`InputProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`InputProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`InputProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`InputProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`InputProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`InputProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`InputProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`InputProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`InputProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`InputProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`InputProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`InputProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`InputProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`InputProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`InputProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`InputProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`InputProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`InputProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`InputProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`InputProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`InputProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`InputProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`InputProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`InputProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`InputProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`InputProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`InputProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`InputProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`InputProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`InputProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`InputProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`InputProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`InputProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`InputProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`InputProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`InputProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`InputProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`InputProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`InputProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`InputProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`InputProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`InputProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`InputProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`InputProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`InputProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`InputProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`InputProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`InputProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`InputProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`InputProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`InputProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`InputProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`InputProps.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `HTMLInputAutoCompleteAttribute`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`InputProps.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`InputProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`InputProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`InputProps.autoSave`

***

### capture?[​](#capture "Direct link to capture?")

> `optional` **capture**: `boolean` | `"environment"` | `"user"`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`InputProps.capture`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`InputProps.checked`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`InputProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`InputProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`InputProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`InputProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`InputProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`InputProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`InputProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`InputProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`InputProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`InputProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`InputProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`InputProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`InputProps.disabled`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`InputProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`InputProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`InputProps.exportparts`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`InputProps.form`

***

### formAction?[​](#formaction "Direct link to formAction?")

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`InputProps.formAction`

***

### formEncType?[​](#formenctype "Direct link to formEncType?")

> `optional` **formEncType**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`InputProps.formEncType`

***

### formMethod?[​](#formmethod "Direct link to formMethod?")

> `optional` **formMethod**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`InputProps.formMethod`

***

### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?")

> `optional` **formNoValidate**: `boolean`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`InputProps.formNoValidate`

***

### formTarget?[​](#formtarget "Direct link to formTarget?")

> `optional` **formTarget**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`InputProps.formTarget`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`InputProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`InputProps.hidden`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

#### Overrides[​](#overrides "Direct link to Overrides")

`InputProps.htmlSize`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The HTML input id

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`InputProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`InputProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`InputProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`InputProps.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Ref of input element

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`InputProps.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`InputProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`InputProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`InputProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`InputProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`InputProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`InputProps.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the input.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`InputProps.lang`

***

### list?[​](#list "Direct link to list?")

> `optional` **list**: `string`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`InputProps.list`

***

### max?[​](#max "Direct link to max?")

> `optional` **max**: `string` | `number`

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`InputProps.max`

***

### maxLength?[​](#maxlength "Direct link to maxLength?")

> `optional` **maxLength**: `number`

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`InputProps.maxLength`

***

### min?[​](#min "Direct link to min?")

> `optional` **min**: `string` | `number`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`InputProps.min`

***

### minLength?[​](#minlength "Direct link to minLength?")

> `optional` **minLength**: `number`

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`InputProps.minLength`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`InputProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`InputProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`InputProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`InputProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`InputProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`InputProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`InputProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`InputProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`InputProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`InputProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`InputProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`InputProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`InputProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`InputProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`InputProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`InputProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`InputProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`InputProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`InputProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`InputProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`InputProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`InputProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `PrependParameters`<`ChangeEventHandler`<`HTMLInputElement`>, \[`string`]>

The callback function in which value is changed.

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`InputProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`InputProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`InputProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`InputProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`InputProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`InputProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`InputProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`InputProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`InputProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`InputProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`InputProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`InputProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`InputProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`InputProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`InputProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`InputProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`InputProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`InputProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`InputProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`InputProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`InputProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`InputProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`InputProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`InputProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`InputProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`InputProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`InputProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`InputProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`InputProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`InputProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`InputProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`InputProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`InputProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`InputProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`InputProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`InputProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`InputProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`InputProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`InputProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`InputProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`InputProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`InputProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`InputProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`InputProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`InputProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`InputProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`InputProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`InputProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`InputProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`InputProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`InputProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`InputProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`InputProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`InputProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`InputProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`InputProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`InputProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`InputProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`InputProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`InputProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`InputProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`InputProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`InputProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`InputProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`InputProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`InputProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`InputProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`InputProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`InputProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`InputProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`InputProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`InputProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`InputProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`InputProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`InputProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`InputProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`InputProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`InputProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`InputProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`InputProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`InputProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`InputProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`InputProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`InputProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`InputProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`InputProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`InputProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`InputProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`InputProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`InputProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`InputProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`InputProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`InputProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`InputProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`InputProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`InputProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`InputProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`InputProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`InputProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`InputProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`InputProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`InputProps.onPointerUpCapture`

***

### onPressEnter?[​](#onpressenter "Direct link to onPressEnter?")

> `optional` **onPressEnter**: `KeyboardEventHandler`<`HTMLInputElement`>

Called on press enter

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`InputProps.onPressEnter`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`InputProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`InputProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`InputProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`InputProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`InputProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`InputProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`InputProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`InputProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`InputProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`InputProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`InputProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`InputProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`InputProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`InputProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`InputProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`InputProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`InputProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`InputProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`InputProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`InputProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`InputProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`InputProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`InputProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`InputProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`InputProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`InputProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`InputProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`InputProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`InputProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`InputProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`InputProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`InputProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`InputProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`InputProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`InputProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`InputProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`InputProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`InputProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`InputProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`InputProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`InputProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`InputProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`InputProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`InputProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`InputProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`InputProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`InputProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`InputProps.part`

***

### passwordMask?[​](#passwordmask "Direct link to passwordMask?")

> `optional` **passwordMask**: `boolean`

Whether to show password mask.

***

### pattern?[​](#pattern "Direct link to pattern?")

> `optional` **pattern**: `string`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`InputProps.pattern`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`InputProps.placeholder`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`InputProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`InputProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`InputProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`InputProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`InputProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`InputProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`InputProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`InputProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`InputProps.rel`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`InputProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`InputProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`InputProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`InputProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`InputProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`InputProps.security`

***

### showPasswordAriaLabel[​](#showpasswordarialabel "Direct link to showPasswordAriaLabel")

> **showPasswordAriaLabel**: `string`

The aria label for the show password button.

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`InputProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`InputProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`InputProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`InputProps.src`

***

### step?[​](#step "Direct link to step?")

> `optional` **step**: `string` | `number`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`InputProps.step`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`InputProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`InputProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`InputProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`InputProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`InputProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`InputProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `"number"` | `"search"` | `"time"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"password"`

The type of the input.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`InputProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`InputProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`InputProps.unselectable`

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`InputProps.value`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`InputProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`InputProps.width`


---

# Interface: RsLabelProps

Props for the RsLabel component.

## Extends[​](#extends "Direct link to Extends")

* `TextProps`

## Properties[​](#properties "Direct link to Properties")

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `string`

The text alignment.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`TextProps.alignment`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`TextProps.backgroundColor`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

The color.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TextProps.color`

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `number`

The font size.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`TextProps.fontSize`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `string`

The font weight.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`TextProps.fontWeight`

***

### text[​](#text "Direct link to text")

> **text**: `string`

The label text content.


---

# Interface: RsLinkProps

Props for the RsLink component.

## Extends[​](#extends "Direct link to Extends")

* `ComponentProps`<`"a"`>.`TextProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ComponentProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ComponentProps.accessKey`

***

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `string`

The text alignment.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TextProps.alignment`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ComponentProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ComponentProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ComponentProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ComponentProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ComponentProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ComponentProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ComponentProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ComponentProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ComponentProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ComponentProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ComponentProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ComponentProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ComponentProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ComponentProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ComponentProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ComponentProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ComponentProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ComponentProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ComponentProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ComponentProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ComponentProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ComponentProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ComponentProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ComponentProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ComponentProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ComponentProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ComponentProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ComponentProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ComponentProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ComponentProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ComponentProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ComponentProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ComponentProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ComponentProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ComponentProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ComponentProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ComponentProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ComponentProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ComponentProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`ComponentProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`ComponentProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`ComponentProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`ComponentProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`ComponentProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`ComponentProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`ComponentProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`ComponentProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`ComponentProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`ComponentProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`ComponentProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`ComponentProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`ComponentProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`ComponentProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`ComponentProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`ComponentProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`ComponentProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`ComponentProps.autoSave`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`TextProps.backgroundColor`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`ComponentProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`ComponentProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`ComponentProps.color`

***

### content[​](#content "Direct link to content")

> **content**: `string`

The content type (text or custom).

#### Overrides[​](#overrides "Direct link to Overrides")

`ComponentProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`ComponentProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`ComponentProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`ComponentProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`ComponentProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`ComponentProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`ComponentProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`ComponentProps.dir`

***

### download?[​](#download "Direct link to download?")

> `optional` **download**: `any`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`ComponentProps.download`

***

### downloadFilename[​](#downloadfilename "Direct link to downloadFilename")

> **downloadFilename**: `string`

The filename for download when download is enabled.

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`ComponentProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`ComponentProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`ComponentProps.exportparts`

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `number`

The font size.

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`TextProps.fontSize`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `string`

The font weight.

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`TextProps.fontWeight`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`ComponentProps.hidden`

***

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`ComponentProps.href`

***

### hrefLang?[​](#hreflang "Direct link to hrefLang?")

> `optional` **hrefLang**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`ComponentProps.hrefLang`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`ComponentProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`ComponentProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`ComponentProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`ComponentProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`ComponentProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`ComponentProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`ComponentProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`ComponentProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`ComponentProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`ComponentProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`ComponentProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`ComponentProps.lang`

***

### media?[​](#media "Direct link to media?")

> `optional` **media**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`ComponentProps.media`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`ComponentProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`ComponentProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`ComponentProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`ComponentProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`ComponentProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`ComponentProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`ComponentProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`ComponentProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`ComponentProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`ComponentProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`ComponentProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`ComponentProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`ComponentProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`ComponentProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`ComponentProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`ComponentProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`ComponentProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`ComponentProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`ComponentProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`ComponentProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`ComponentProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`ComponentProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`ComponentProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`ComponentProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`ComponentProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`ComponentProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`ComponentProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`ComponentProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`ComponentProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`ComponentProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`ComponentProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`ComponentProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`ComponentProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`ComponentProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`ComponentProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`ComponentProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`ComponentProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`ComponentProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`ComponentProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`ComponentProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`ComponentProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`ComponentProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`ComponentProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`ComponentProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`ComponentProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`ComponentProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`ComponentProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`ComponentProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`ComponentProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`ComponentProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`ComponentProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`ComponentProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`ComponentProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`ComponentProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`ComponentProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`ComponentProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`ComponentProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`ComponentProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`ComponentProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`ComponentProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`ComponentProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`ComponentProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`ComponentProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`ComponentProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`ComponentProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`ComponentProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`ComponentProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`ComponentProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`ComponentProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`ComponentProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`ComponentProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`ComponentProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`ComponentProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`ComponentProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`ComponentProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`ComponentProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`ComponentProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`ComponentProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`ComponentProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`ComponentProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`ComponentProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`ComponentProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`ComponentProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`ComponentProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`ComponentProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`ComponentProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`ComponentProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`ComponentProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`ComponentProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`ComponentProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`ComponentProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`ComponentProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`ComponentProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`ComponentProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`ComponentProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`ComponentProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`ComponentProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`ComponentProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`ComponentProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`ComponentProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`ComponentProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`ComponentProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`ComponentProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`ComponentProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`ComponentProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`ComponentProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`ComponentProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`ComponentProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`ComponentProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`ComponentProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`ComponentProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`ComponentProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`ComponentProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`ComponentProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`ComponentProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`ComponentProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`ComponentProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`ComponentProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`ComponentProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`ComponentProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`ComponentProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`ComponentProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`ComponentProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`ComponentProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`ComponentProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`ComponentProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`ComponentProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`ComponentProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`ComponentProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`ComponentProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`ComponentProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`ComponentProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`ComponentProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`ComponentProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`ComponentProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`ComponentProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`ComponentProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`ComponentProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`ComponentProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`ComponentProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`ComponentProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`ComponentProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`ComponentProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`ComponentProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`ComponentProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`ComponentProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`ComponentProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`ComponentProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`ComponentProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`ComponentProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`ComponentProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`ComponentProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`ComponentProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`ComponentProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`ComponentProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`ComponentProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`ComponentProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`ComponentProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`ComponentProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`ComponentProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`ComponentProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`ComponentProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`ComponentProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`ComponentProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`ComponentProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`ComponentProps.part`

***

### ping?[​](#ping "Direct link to ping?")

> `optional` **ping**: `string`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`ComponentProps.ping`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`ComponentProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`ComponentProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`ComponentProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ComponentProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`ComponentProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`ComponentProps.radioGroup`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLAnchorElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ComponentProps.ref`

***

### referrerPolicy?[​](#referrerpolicy "Direct link to referrerPolicy?")

> `optional` **referrerPolicy**: `HTMLAttributeReferrerPolicy`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`ComponentProps.referrerPolicy`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`ComponentProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`ComponentProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`ComponentProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`ComponentProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`ComponentProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`ComponentProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`ComponentProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`ComponentProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`ComponentProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`ComponentProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`ComponentProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`ComponentProps.tabIndex`

***

### target?[​](#target "Direct link to target?")

> `optional` **target**: `HTMLAttributeAnchorTarget`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`ComponentProps.target`

***

### text[​](#text "Direct link to text")

> **text**: `string`

The link text content.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`ComponentProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`ComponentProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`ComponentProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`ComponentProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`ComponentProps.unselectable`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`ComponentProps.vocab`


---

# Interface: RsMenuProps

Props for the RsMenu component.

## Extends[​](#extends "Direct link to Extends")

* `NavProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`NavProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`NavProps.accessKey`

***

### activeKey?[​](#activekey "Direct link to activeKey?")

> `optional` **activeKey**: `any`

The active key of the Nav component.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`NavProps.activeKey`

***

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `"default"` | `"tabs"` | `"subtle"` | `"pills"`

The appearance style of the Nav component.

#### Default[​](#default "Direct link to Default")

```
'default'
```

#### Version[​](#version "Direct link to Version")

'pills' is supported in version 5.68.0

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`NavProps.appearance`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`NavProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`NavProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`NavProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`NavProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`NavProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`NavProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`NavProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`NavProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`NavProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`NavProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`NavProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`NavProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`NavProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`NavProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`NavProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`NavProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`NavProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`NavProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`NavProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`NavProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`NavProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`NavProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`NavProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`NavProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`NavProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`NavProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`NavProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`NavProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`NavProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`NavProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`NavProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`NavProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`NavProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`NavProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`NavProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`NavProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`NavProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`NavProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`NavProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`NavProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`NavProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`NavProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`NavProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`NavProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`NavProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`NavProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`NavProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`NavProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`NavProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`NavProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`NavProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`NavProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`NavProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`NavProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`NavProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`NavProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`NavProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`NavProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`NavProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`NavProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`NavProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`NavProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`NavProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`NavProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`NavProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`NavProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`NavProps.datatype`

***

### defaultActiveKey?[​](#defaultactivekey "Direct link to defaultActiveKey?")

> `optional` **defaultActiveKey**: `any`

The default active key of the Nav component.

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`NavProps.defaultActiveKey`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`NavProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`NavProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`NavProps.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`NavProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`NavProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`NavProps.exportparts`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`NavProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`NavProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`NavProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`NavProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`NavProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`NavProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`NavProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`NavProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`NavProps.itemRef`

***

### items?[​](#items "Direct link to items?")

> `optional` **items**: [`MenuItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/MenuItem)\[]

The items for the menu.

***

### itemsAs[​](#itemsas "Direct link to itemsAs")

> **itemsAs**: `ElementType`

The element type for menu items.

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`NavProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`NavProps.itemType`

***

### justified?[​](#justified "Direct link to justified?")

> `optional` **justified**: `boolean`

Whether the Nav component is justified.

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`NavProps.justified`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`NavProps.lang`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`NavProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`NavProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`NavProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`NavProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`NavProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`NavProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`NavProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`NavProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`NavProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`NavProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`NavProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`NavProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`NavProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`NavProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`NavProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`NavProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`NavProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`NavProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`NavProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`NavProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`NavProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`NavProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`NavProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`NavProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`NavProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`NavProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`NavProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`NavProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`NavProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`NavProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`NavProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`NavProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`NavProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`NavProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`NavProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`NavProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`NavProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`NavProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`NavProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`NavProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`NavProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`NavProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`NavProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`NavProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`NavProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`NavProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`NavProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`NavProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`NavProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`NavProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`NavProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`NavProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`NavProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`NavProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`NavProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`NavProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`NavProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`NavProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`NavProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`NavProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`NavProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`NavProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`NavProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`NavProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`NavProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`NavProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`NavProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`NavProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`NavProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`NavProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`NavProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`NavProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`NavProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`NavProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`NavProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`NavProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`NavProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`NavProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`NavProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`NavProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`NavProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`NavProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`NavProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`NavProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`NavProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`NavProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`NavProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`NavProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`NavProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`NavProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`NavProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`NavProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`NavProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`NavProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`NavProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`NavProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`NavProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`NavProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`NavProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`NavProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`NavProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`NavProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`NavProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`NavProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`NavProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`NavProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`NavProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`NavProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`NavProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`NavProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`NavProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`NavProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`NavProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`NavProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`NavProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`NavProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`NavProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`NavProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`NavProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`NavProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`NavProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`NavProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`NavProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`NavProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`NavProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`NavProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`NavProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`NavProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`NavProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`NavProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`NavProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`NavProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`NavProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`NavProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`NavProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`NavProps.onSeekingCapture`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`eventKey`, `event`) => `void`

Event handler for selecting a Nav item.

#### Parameters[​](#parameters "Direct link to Parameters")

##### eventKey[​](#eventkey "Direct link to eventKey")

`any`

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`NavProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`NavProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`NavProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`NavProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`NavProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`NavProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`NavProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`NavProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`NavProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`NavProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`NavProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`NavProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`NavProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`NavProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`NavProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`NavProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`NavProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`NavProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`NavProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`NavProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`NavProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`NavProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`NavProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`NavProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`NavProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`NavProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`NavProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`NavProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`NavProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`NavProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`NavProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`NavProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`NavProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`NavProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`NavProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`NavProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`NavProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`NavProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`NavProps.property`

***

### pullRight?[​](#pullright "Direct link to pullRight?")

> `optional` **pullRight**: `boolean`

Whether the Nav component is pulled to the right.

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`NavProps.pullRight`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`NavProps.radioGroup`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`NavProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`NavProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`NavProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`NavProps.rev`

***

### reversed?[​](#reversed "Direct link to reversed?")

> `optional` **reversed**: `boolean`

Whether the Nav component is reversed.

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`NavProps.reversed`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`NavProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`NavProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`NavProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`NavProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`NavProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`NavProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`NavProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`NavProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`NavProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`NavProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`NavProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`NavProps.unselectable`

***

### vertical?[​](#vertical "Direct link to vertical?")

> `optional` **vertical**: `boolean`

Whether the Nav component is vertical.

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`NavProps.vertical`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`NavProps.vocab`


---

# Interface: RsModalLayoutProps

Props for the RsModalLayout component.

## Properties[​](#properties "Direct link to Properties")

### body[​](#body "Direct link to body")

> **body**: `ReactNode`

The content for the modal body.

***

### closeButton[​](#closebutton "Direct link to closeButton")

> **closeButton**: `boolean`

Whether to show the close button.

***

### footer[​](#footer "Direct link to footer")

> **footer**: `ReactNode`

The content for the modal footer.

***

### headerTitle[​](#headertitle "Direct link to headerTitle")

> **headerTitle**: `ReactNode`

The title for the modal header.


---

# Interface: RsModalProps

Props for the RsModal component.

## Extends[​](#extends "Direct link to Extends")

* `ModalProps`

## Properties[​](#properties "Direct link to Properties")

### animation?[​](#animation "Direct link to animation?")

> `optional` **animation**: `ElementType`<`any`, keyof IntrinsicElements>

Set an animation effect for Modal, the default is Bounce.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ModalProps.animation`

***

### animationProps?[​](#animationprops "Direct link to animationProps?")

> `optional` **animationProps**: `any`

Animation-related properties

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ModalProps.animationProps`

***

### animationTimeout?[​](#animationtimeout "Direct link to animationTimeout?")

> `optional` **animationTimeout**: `number`

Set the duration of the animation

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ModalProps.animationTimeout`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ModalProps.aria-describedby`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-1 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ModalProps.aria-labelledby`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ModalProps.as`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

When set to true, the Modal is opened and is automatically focused on its own, accessible to screen readers

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ModalProps.autoFocus`

***

### backdrop?[​](#backdrop "Direct link to backdrop?")

> `optional` **backdrop**: `boolean` | `"static"`

When set to true, the Modal will display the background when it is opened. Clicking on the background will close the Modal. If you do not want to close the Modal, set it to 'static'.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ModalProps.backdrop`

***

### backdropClassName?[​](#backdropclassname "Direct link to backdropClassName?")

> `optional` **backdropClassName**: `string`

Add an optional extra class name to .modal-backdrop It could end up looking like class="modal-backdrop foo-modal-backdrop in"

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ModalProps.backdropClassName`

***

### backdropStyle?[​](#backdropstyle "Direct link to backdropStyle?")

> `optional` **backdropStyle**: `CSSProperties`

CSS style applied to backdrop DOM nodes

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ModalProps.backdropStyle`

***

### backdropTransitionTimeout?[​](#backdroptransitiontimeout "Direct link to backdropTransitionTimeout?")

> `optional` **backdropTransitionTimeout**: `number`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ModalProps.backdropTransitionTimeout`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ModalProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ModalProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ModalProps.classPrefix`

***

### closeButton?[​](#closebutton "Direct link to closeButton?")

> `optional` **closeButton**: `ReactNode`

Custom close button, used when rendered as a Drawer

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ModalProps.closeButton`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ModalProps.container`

***

### containerClassName?[​](#containerclassname "Direct link to containerClassName?")

> `optional` **containerClassName**: `string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ModalProps.containerClassName`

***

### dialogAs?[​](#dialogas "Direct link to dialogAs?")

> `optional` **dialogAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element type for Dialog

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ModalProps.dialogAs`

***

### dialogClassName?[​](#dialogclassname "Direct link to dialogClassName?")

> `optional` **dialogClassName**: `string`

CSS class applied to Dialog DOM nodes

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ModalProps.dialogClassName`

***

### dialogStyle?[​](#dialogstyle "Direct link to dialogStyle?")

> `optional` **dialogStyle**: `CSSProperties`

CSS style applied to dialog DOM nodes

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ModalProps.dialogStyle`

***

### dialogTransitionTimeout?[​](#dialogtransitiontimeout "Direct link to dialogTransitionTimeout?")

> `optional` **dialogTransitionTimeout**: `number`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ModalProps.dialogTransitionTimeout`

***

### enforceFocus?[​](#enforcefocus "Direct link to enforceFocus?")

> `optional` **enforceFocus**: `boolean`

When set to true, Modal will prevent the focus from leaving when opened, making it easier for the secondary screen reader to access

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ModalProps.enforceFocus`

***

### ~~full?~~[​](#full "Direct link to full")

> `optional` **full**: `boolean`

Full screen

#### Deprecated[​](#deprecated "Direct link to Deprecated")

Use size="full" instead.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ModalProps.full`

***

### handleClose()?[​](#handleclose "Direct link to handleClose()?")

> `optional` **handleClose**: () => `void`

Custom close handler function.

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ModalProps.id`

***

### isDrawer?[​](#isdrawer "Direct link to isDrawer?")

> `optional` **isDrawer**: `boolean`

Indicates if the component should be displayed as a drawer

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ModalProps.isDrawer`

***

### keyboard?[​](#keyboard "Direct link to keyboard?")

> `optional` **keyboard**: `boolean`

Close Modal when esc key is pressed

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ModalProps.keyboard`

***

### onBackdropClick?[​](#onbackdropclick "Direct link to onBackdropClick?")

> `optional` **onBackdropClick**: `MouseEventHandler`<`Element`>

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ModalProps.onBackdropClick`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: (`event`) => `void`

Called when Modal is closed

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ModalProps.onClose`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ModalProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ModalProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ModalProps.onEntering`

***

### onEsc?[​](#onesc "Direct link to onEsc?")

> `optional` **onEsc**: `KeyboardEventHandler`<`Element`>

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ModalProps.onEsc`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ModalProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ModalProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ModalProps.onExiting`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ModalProps.onOpen`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open modal

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ModalProps.open`

***

### overflow?[​](#overflow "Direct link to overflow?")

> `optional` **overflow**: `boolean`

Automatically sets the height when the body content is too long.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ModalProps.overflow`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ModalProps.role`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `ModalSize`

A modal can have different sizes

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ModalProps.size`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ModalProps.style`

***

### transition?[​](#transition "Direct link to transition?")

> `optional` **transition**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ModalProps.transition`


---

# Interface: RsNumberFormatProps

Props for the RsNumberFormat component.

## Extends[​](#extends "Direct link to Extends")

* `NumericFormatProps`<`InputProps`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`NumericFormatProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`NumericFormatProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`NumericFormatProps.accessKey`

***

### allowedDecimalSeparators?[​](#alloweddecimalseparators "Direct link to allowedDecimalSeparators?")

> `optional` **allowedDecimalSeparators**: `string`\[]

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`NumericFormatProps.allowedDecimalSeparators`

***

### allowLeadingZeros?[​](#allowleadingzeros "Direct link to allowLeadingZeros?")

> `optional` **allowLeadingZeros**: `boolean`

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`NumericFormatProps.allowLeadingZeros`

***

### allowNegative?[​](#allownegative "Direct link to allowNegative?")

> `optional` **allowNegative**: `boolean`

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`NumericFormatProps.allowNegative`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`NumericFormatProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`NumericFormatProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`NumericFormatProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`NumericFormatProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`NumericFormatProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`NumericFormatProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`NumericFormatProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`NumericFormatProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`NumericFormatProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`NumericFormatProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`NumericFormatProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`NumericFormatProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`NumericFormatProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`NumericFormatProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`NumericFormatProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`NumericFormatProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`NumericFormatProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`NumericFormatProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`NumericFormatProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`NumericFormatProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`NumericFormatProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`NumericFormatProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`NumericFormatProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`NumericFormatProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`NumericFormatProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`NumericFormatProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`NumericFormatProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`NumericFormatProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`NumericFormatProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`NumericFormatProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`NumericFormatProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`NumericFormatProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`NumericFormatProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`NumericFormatProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`NumericFormatProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`NumericFormatProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`NumericFormatProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`NumericFormatProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`NumericFormatProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`NumericFormatProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`NumericFormatProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`NumericFormatProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`NumericFormatProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`NumericFormatProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`NumericFormatProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`NumericFormatProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`NumericFormatProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`NumericFormatProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`NumericFormatProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`NumericFormatProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`NumericFormatProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`NumericFormatProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`NumericFormatProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`NumericFormatProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`NumericFormatProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`NumericFormatProps.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `HTMLInputAutoCompleteAttribute`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`NumericFormatProps.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`NumericFormatProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`NumericFormatProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`NumericFormatProps.autoSave`

***

### capture?[​](#capture "Direct link to capture?")

> `optional` **capture**: `boolean` | `"environment"` | `"user"`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`NumericFormatProps.capture`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`NumericFormatProps.checked`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`NumericFormatProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`NumericFormatProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`NumericFormatProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`NumericFormatProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`NumericFormatProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`NumericFormatProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`NumericFormatProps.contextMenu`

***

### customInput?[​](#custominput "Direct link to customInput?")

> `optional` **customInput**: `ComponentType`<`InputProps`>

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`NumericFormatProps.customInput`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`NumericFormatProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`NumericFormatProps.datatype`

***

### decimalScale?[​](#decimalscale "Direct link to decimalScale?")

> `optional` **decimalScale**: `number`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`NumericFormatProps.decimalScale`

***

### decimalSeparator?[​](#decimalseparator "Direct link to decimalSeparator?")

> `optional` **decimalSeparator**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`NumericFormatProps.decimalSeparator`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`NumericFormatProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`NumericFormatProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`NumericFormatProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`NumericFormatProps.disabled`

***

### displayType?[​](#displaytype "Direct link to displayType?")

> `optional` **displayType**: `"input"` | `"text"`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`NumericFormatProps.displayType`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`NumericFormatProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`NumericFormatProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`NumericFormatProps.exportparts`

***

### fixedDecimalScale?[​](#fixeddecimalscale "Direct link to fixedDecimalScale?")

> `optional` **fixedDecimalScale**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`NumericFormatProps.fixedDecimalScale`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`NumericFormatProps.form`

***

### formAction?[​](#formaction "Direct link to formAction?")

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`NumericFormatProps.formAction`

***

### formEncType?[​](#formenctype "Direct link to formEncType?")

> `optional` **formEncType**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`NumericFormatProps.formEncType`

***

### formMethod?[​](#formmethod "Direct link to formMethod?")

> `optional` **formMethod**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`NumericFormatProps.formMethod`

***

### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?")

> `optional` **formNoValidate**: `boolean`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`NumericFormatProps.formNoValidate`

***

### formTarget?[​](#formtarget "Direct link to formTarget?")

> `optional` **formTarget**: `string`

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`NumericFormatProps.formTarget`

***

### getInputRef?[​](#getinputref "Direct link to getInputRef?")

> `optional` **getInputRef**: `Ref`<`any`> | (`el`) => `void`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`NumericFormatProps.getInputRef`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`NumericFormatProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`NumericFormatProps.hidden`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

#### Overrides[​](#overrides "Direct link to Overrides")

`NumericFormatProps.htmlSize`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The HTML input id

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`NumericFormatProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`NumericFormatProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`NumericFormatProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`NumericFormatProps.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Ref of input element

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`NumericFormatProps.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`NumericFormatProps.is`

***

### isAllowed()?[​](#isallowed "Direct link to isAllowed()?")

> `optional` **isAllowed**: (`values`) => `boolean`

#### Parameters[​](#parameters "Direct link to Parameters")

##### values[​](#values "Direct link to values")

`NumberFormatValues`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`NumericFormatProps.isAllowed`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`NumericFormatProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`NumericFormatProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`NumericFormatProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`NumericFormatProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`NumericFormatProps.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the number input.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`NumericFormatProps.lang`

***

### list?[​](#list "Direct link to list?")

> `optional` **list**: `string`

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`NumericFormatProps.list`

***

### max?[​](#max "Direct link to max?")

> `optional` **max**: `string` | `number`

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`NumericFormatProps.max`

***

### maxLength?[​](#maxlength "Direct link to maxLength?")

> `optional` **maxLength**: `number`

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`NumericFormatProps.maxLength`

***

### min?[​](#min "Direct link to min?")

> `optional` **min**: `string` | `number`

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`NumericFormatProps.min`

***

### minLength?[​](#minlength "Direct link to minLength?")

> `optional` **minLength**: `number`

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`NumericFormatProps.minLength`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`NumericFormatProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`NumericFormatProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`NumericFormatProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`NumericFormatProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`NumericFormatProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`NumericFormatProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`NumericFormatProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`NumericFormatProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`NumericFormatProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`NumericFormatProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`NumericFormatProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`NumericFormatProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`NumericFormatProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`NumericFormatProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`NumericFormatProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`NumericFormatProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`NumericFormatProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`NumericFormatProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`NumericFormatProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`NumericFormatProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`NumericFormatProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`NumericFormatProps.onCanPlayThroughCapture`

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`value`) => `void`

The callback function called when the value changes.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`NumericFormatProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`NumericFormatProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`NumericFormatProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`NumericFormatProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`NumericFormatProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`NumericFormatProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`NumericFormatProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`NumericFormatProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`NumericFormatProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`NumericFormatProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`NumericFormatProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`NumericFormatProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`NumericFormatProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`NumericFormatProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`NumericFormatProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`NumericFormatProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`NumericFormatProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`NumericFormatProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`NumericFormatProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`NumericFormatProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`NumericFormatProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`NumericFormatProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`NumericFormatProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`NumericFormatProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`NumericFormatProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`NumericFormatProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`NumericFormatProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`NumericFormatProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`NumericFormatProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`NumericFormatProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`NumericFormatProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`NumericFormatProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`NumericFormatProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`NumericFormatProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`NumericFormatProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`NumericFormatProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`NumericFormatProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`NumericFormatProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`NumericFormatProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`NumericFormatProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`NumericFormatProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`NumericFormatProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`NumericFormatProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`NumericFormatProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`NumericFormatProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`NumericFormatProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`NumericFormatProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`NumericFormatProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`NumericFormatProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`NumericFormatProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`NumericFormatProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`NumericFormatProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`NumericFormatProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`NumericFormatProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`NumericFormatProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`NumericFormatProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`NumericFormatProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`NumericFormatProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`NumericFormatProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`NumericFormatProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`NumericFormatProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`NumericFormatProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`NumericFormatProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`NumericFormatProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`NumericFormatProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`NumericFormatProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`NumericFormatProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`NumericFormatProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`NumericFormatProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`NumericFormatProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`NumericFormatProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`NumericFormatProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`NumericFormatProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`NumericFormatProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`NumericFormatProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`NumericFormatProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`NumericFormatProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`NumericFormatProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`NumericFormatProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`NumericFormatProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`NumericFormatProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`NumericFormatProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`NumericFormatProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`NumericFormatProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`NumericFormatProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`NumericFormatProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`NumericFormatProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`NumericFormatProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`NumericFormatProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`NumericFormatProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`NumericFormatProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`NumericFormatProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`NumericFormatProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`NumericFormatProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`NumericFormatProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`NumericFormatProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`NumericFormatProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`NumericFormatProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`NumericFormatProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`NumericFormatProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`NumericFormatProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`NumericFormatProps.onPointerUpCapture`

***

### onPressEnter?[​](#onpressenter "Direct link to onPressEnter?")

> `optional` **onPressEnter**: `KeyboardEventHandler`<`HTMLInputElement`>

Called on press enter

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`NumericFormatProps.onPressEnter`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`NumericFormatProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`NumericFormatProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`NumericFormatProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`NumericFormatProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`NumericFormatProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`NumericFormatProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`NumericFormatProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`NumericFormatProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`NumericFormatProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`NumericFormatProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`NumericFormatProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`NumericFormatProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`NumericFormatProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`NumericFormatProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`NumericFormatProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`NumericFormatProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`NumericFormatProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`NumericFormatProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`NumericFormatProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`NumericFormatProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`NumericFormatProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`NumericFormatProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`NumericFormatProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`NumericFormatProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`NumericFormatProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`NumericFormatProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`NumericFormatProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`NumericFormatProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`NumericFormatProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`NumericFormatProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`NumericFormatProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`NumericFormatProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`NumericFormatProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`NumericFormatProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`NumericFormatProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`NumericFormatProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`NumericFormatProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`NumericFormatProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`NumericFormatProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`NumericFormatProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`NumericFormatProps.onTransitionStartCapture`

***

### onValueChange?[​](#onvaluechange "Direct link to onValueChange?")

> `optional` **onValueChange**: `OnValueChange`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`NumericFormatProps.onValueChange`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`NumericFormatProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`NumericFormatProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`NumericFormatProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`NumericFormatProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`NumericFormatProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`NumericFormatProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-32 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`NumericFormatProps.part`

***

### pattern?[​](#pattern "Direct link to pattern?")

> `optional` **pattern**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`NumericFormatProps.pattern`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`NumericFormatProps.placeholder`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`NumericFormatProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`NumericFormatProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`NumericFormatProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`NumericFormatProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`NumericFormatProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`NumericFormatProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`NumericFormatProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`NumericFormatProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`NumericFormatProps.rel`

***

### renderText()?[​](#rendertext "Direct link to renderText()?")

> `optional` **renderText**: (`formattedValue`, `otherProps`) => `ReactNode`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### formattedValue[​](#formattedvalue "Direct link to formattedValue")

`string`

##### otherProps[​](#otherprops "Direct link to otherProps")

`Partial`<`NumberFormatBase`>

#### Returns[​](#returns-2 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`NumericFormatProps.renderText`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`NumericFormatProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`NumericFormatProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`NumericFormatProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`NumericFormatProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`NumericFormatProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`NumericFormatProps.security`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`NumericFormatProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`NumericFormatProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`NumericFormatProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`NumericFormatProps.src`

***

### step?[​](#step "Direct link to step?")

> `optional` **step**: `string` | `number`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`NumericFormatProps.step`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`NumericFormatProps.style`

***

### suffix?[​](#suffix "Direct link to suffix?")

> `optional` **suffix**: `string`

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`NumericFormatProps.suffix`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`NumericFormatProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`NumericFormatProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`NumericFormatProps.tabIndex`

***

### thousandSeparator?[​](#thousandseparator "Direct link to thousandSeparator?")

> `optional` **thousandSeparator**: `string` | `boolean`

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`NumericFormatProps.thousandSeparator`

***

### thousandsGroupStyle?[​](#thousandsgroupstyle "Direct link to thousandsGroupStyle?")

> `optional` **thousandsGroupStyle**: `"none"` | `"thousand"` | `"lakh"` | `"wan"`

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`NumericFormatProps.thousandsGroupStyle`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`NumericFormatProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`NumericFormatProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `"text"` | `"tel"` | `"password"`

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`NumericFormatProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-322 "Direct link to Inherited from")

`NumericFormatProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-323 "Direct link to Inherited from")

`NumericFormatProps.unselectable`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-324 "Direct link to Inherited from")

`NumericFormatProps.value`

***

### valueIsNumericString?[​](#valueisnumericstring "Direct link to valueIsNumericString?")

> `optional` **valueIsNumericString**: `boolean`

#### Inherited from[​](#inherited-from-325 "Direct link to Inherited from")

`NumericFormatProps.valueIsNumericString`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-326 "Direct link to Inherited from")

`NumericFormatProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-327 "Direct link to Inherited from")

`NumericFormatProps.width`


---

# Interface: RsPatternFormatProps

Props for the RsPatternFormat component.

## Extends[​](#extends "Direct link to Extends")

* `PatternFormatProps`<`InputProps`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`PatternFormatProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`PatternFormatProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`PatternFormatProps.accessKey`

***

### allowEmptyFormatting?[​](#allowemptyformatting "Direct link to allowEmptyFormatting?")

> `optional` **allowEmptyFormatting**: `boolean`

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`PatternFormatProps.allowEmptyFormatting`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`PatternFormatProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`PatternFormatProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`PatternFormatProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`PatternFormatProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`PatternFormatProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`PatternFormatProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`PatternFormatProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`PatternFormatProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`PatternFormatProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`PatternFormatProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`PatternFormatProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`PatternFormatProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`PatternFormatProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`PatternFormatProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`PatternFormatProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`PatternFormatProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`PatternFormatProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`PatternFormatProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`PatternFormatProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`PatternFormatProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`PatternFormatProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`PatternFormatProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`PatternFormatProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`PatternFormatProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`PatternFormatProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`PatternFormatProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`PatternFormatProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`PatternFormatProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`PatternFormatProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`PatternFormatProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`PatternFormatProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`PatternFormatProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`PatternFormatProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`PatternFormatProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`PatternFormatProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`PatternFormatProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`PatternFormatProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`PatternFormatProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`PatternFormatProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`PatternFormatProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`PatternFormatProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`PatternFormatProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`PatternFormatProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`PatternFormatProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`PatternFormatProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`PatternFormatProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`PatternFormatProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`PatternFormatProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`PatternFormatProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`PatternFormatProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`PatternFormatProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`PatternFormatProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`PatternFormatProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`PatternFormatProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`PatternFormatProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`PatternFormatProps.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `HTMLInputAutoCompleteAttribute`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`PatternFormatProps.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`PatternFormatProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`PatternFormatProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`PatternFormatProps.autoSave`

***

### capture?[​](#capture "Direct link to capture?")

> `optional` **capture**: `boolean` | `"environment"` | `"user"`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`PatternFormatProps.capture`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`PatternFormatProps.checked`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`PatternFormatProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`PatternFormatProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`PatternFormatProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`PatternFormatProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`PatternFormatProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`PatternFormatProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`PatternFormatProps.contextMenu`

***

### customInput?[​](#custominput "Direct link to customInput?")

> `optional` **customInput**: `ComponentType`<`InputProps`>

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`PatternFormatProps.customInput`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`PatternFormatProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`PatternFormatProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`PatternFormatProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`PatternFormatProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`PatternFormatProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`PatternFormatProps.disabled`

***

### displayType?[​](#displaytype "Direct link to displayType?")

> `optional` **displayType**: `"input"` | `"text"`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`PatternFormatProps.displayType`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`PatternFormatProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`PatternFormatProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`PatternFormatProps.exportparts`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`PatternFormatProps.form`

***

### formAction?[​](#formaction "Direct link to formAction?")

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`>

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`PatternFormatProps.formAction`

***

### format[​](#format "Direct link to format")

> **format**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`PatternFormatProps.format`

***

### formEncType?[​](#formenctype "Direct link to formEncType?")

> `optional` **formEncType**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`PatternFormatProps.formEncType`

***

### formMethod?[​](#formmethod "Direct link to formMethod?")

> `optional` **formMethod**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`PatternFormatProps.formMethod`

***

### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?")

> `optional` **formNoValidate**: `boolean`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`PatternFormatProps.formNoValidate`

***

### formTarget?[​](#formtarget "Direct link to formTarget?")

> `optional` **formTarget**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`PatternFormatProps.formTarget`

***

### getInputRef?[​](#getinputref "Direct link to getInputRef?")

> `optional` **getInputRef**: `Ref`<`any`> | (`el`) => `void`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`PatternFormatProps.getInputRef`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`PatternFormatProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`PatternFormatProps.hidden`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

#### Overrides[​](#overrides "Direct link to Overrides")

`PatternFormatProps.htmlSize`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The HTML input id

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`PatternFormatProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`PatternFormatProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`PatternFormatProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`PatternFormatProps.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Ref of input element

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`PatternFormatProps.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`PatternFormatProps.is`

***

### isAllowed()?[​](#isallowed "Direct link to isAllowed()?")

> `optional` **isAllowed**: (`values`) => `boolean`

#### Parameters[​](#parameters "Direct link to Parameters")

##### values[​](#values "Direct link to values")

`NumberFormatValues`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`PatternFormatProps.isAllowed`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`PatternFormatProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`PatternFormatProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`PatternFormatProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`PatternFormatProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`PatternFormatProps.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the pattern format input.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`PatternFormatProps.lang`

***

### list?[​](#list "Direct link to list?")

> `optional` **list**: `string`

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`PatternFormatProps.list`

***

### mask?[​](#mask "Direct link to mask?")

> `optional` **mask**: `string` | `string`\[]

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`PatternFormatProps.mask`

***

### max?[​](#max "Direct link to max?")

> `optional` **max**: `string` | `number`

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`PatternFormatProps.max`

***

### maxLength?[​](#maxlength "Direct link to maxLength?")

> `optional` **maxLength**: `number`

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`PatternFormatProps.maxLength`

***

### min?[​](#min "Direct link to min?")

> `optional` **min**: `string` | `number`

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`PatternFormatProps.min`

***

### minLength?[​](#minlength "Direct link to minLength?")

> `optional` **minLength**: `number`

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`PatternFormatProps.minLength`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`PatternFormatProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`PatternFormatProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`PatternFormatProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`PatternFormatProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`PatternFormatProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`PatternFormatProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`PatternFormatProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`PatternFormatProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`PatternFormatProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`PatternFormatProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`PatternFormatProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`PatternFormatProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`PatternFormatProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`PatternFormatProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`PatternFormatProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`PatternFormatProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`PatternFormatProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`PatternFormatProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`PatternFormatProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`PatternFormatProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`PatternFormatProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`PatternFormatProps.onCanPlayThroughCapture`

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`value`) => `void`

The callback when value changes.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`PatternFormatProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`PatternFormatProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`PatternFormatProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`PatternFormatProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`PatternFormatProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`PatternFormatProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`PatternFormatProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`PatternFormatProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`PatternFormatProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`PatternFormatProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`PatternFormatProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`PatternFormatProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`PatternFormatProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`PatternFormatProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`PatternFormatProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`PatternFormatProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`PatternFormatProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`PatternFormatProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`PatternFormatProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`PatternFormatProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`PatternFormatProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`PatternFormatProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`PatternFormatProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`PatternFormatProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`PatternFormatProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`PatternFormatProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`PatternFormatProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`PatternFormatProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`PatternFormatProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`PatternFormatProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`PatternFormatProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`PatternFormatProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`PatternFormatProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`PatternFormatProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`PatternFormatProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`PatternFormatProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`PatternFormatProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`PatternFormatProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`PatternFormatProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`PatternFormatProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`PatternFormatProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`PatternFormatProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`PatternFormatProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`PatternFormatProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`PatternFormatProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`PatternFormatProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`PatternFormatProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`PatternFormatProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`PatternFormatProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`PatternFormatProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`PatternFormatProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`PatternFormatProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`PatternFormatProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`PatternFormatProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`PatternFormatProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`PatternFormatProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`PatternFormatProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`PatternFormatProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`PatternFormatProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`PatternFormatProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`PatternFormatProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`PatternFormatProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`PatternFormatProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`PatternFormatProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`PatternFormatProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`PatternFormatProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`PatternFormatProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`PatternFormatProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`PatternFormatProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`PatternFormatProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`PatternFormatProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`PatternFormatProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`PatternFormatProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`PatternFormatProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`PatternFormatProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`PatternFormatProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`PatternFormatProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`PatternFormatProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`PatternFormatProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`PatternFormatProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`PatternFormatProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`PatternFormatProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`PatternFormatProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`PatternFormatProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`PatternFormatProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`PatternFormatProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`PatternFormatProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`PatternFormatProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`PatternFormatProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`PatternFormatProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`PatternFormatProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`PatternFormatProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`PatternFormatProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`PatternFormatProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`PatternFormatProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`PatternFormatProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`PatternFormatProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`PatternFormatProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`PatternFormatProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`PatternFormatProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`PatternFormatProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`PatternFormatProps.onPointerUpCapture`

***

### onPressEnter?[​](#onpressenter "Direct link to onPressEnter?")

> `optional` **onPressEnter**: `KeyboardEventHandler`<`HTMLInputElement`>

Called on press enter

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`PatternFormatProps.onPressEnter`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`PatternFormatProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`PatternFormatProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`PatternFormatProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`PatternFormatProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`PatternFormatProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`PatternFormatProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`PatternFormatProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`PatternFormatProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`PatternFormatProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`PatternFormatProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`PatternFormatProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`PatternFormatProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`PatternFormatProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`PatternFormatProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`PatternFormatProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`PatternFormatProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`PatternFormatProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`PatternFormatProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`PatternFormatProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`PatternFormatProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`PatternFormatProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`PatternFormatProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`PatternFormatProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`PatternFormatProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`PatternFormatProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`PatternFormatProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`PatternFormatProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`PatternFormatProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`PatternFormatProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`PatternFormatProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`PatternFormatProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`PatternFormatProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`PatternFormatProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`PatternFormatProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`PatternFormatProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`PatternFormatProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`PatternFormatProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`PatternFormatProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`PatternFormatProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`PatternFormatProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`PatternFormatProps.onTransitionStartCapture`

***

### onValueChange?[​](#onvaluechange "Direct link to onValueChange?")

> `optional` **onValueChange**: `OnValueChange`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`PatternFormatProps.onValueChange`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`PatternFormatProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`PatternFormatProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`PatternFormatProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`PatternFormatProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`PatternFormatProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`PatternFormatProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-32 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`PatternFormatProps.part`

***

### pattern?[​](#pattern "Direct link to pattern?")

> `optional` **pattern**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`PatternFormatProps.pattern`

***

### patternChar?[​](#patternchar "Direct link to patternChar?")

> `optional` **patternChar**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`PatternFormatProps.patternChar`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`PatternFormatProps.placeholder`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`PatternFormatProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`PatternFormatProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`PatternFormatProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`PatternFormatProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`PatternFormatProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`PatternFormatProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`PatternFormatProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`PatternFormatProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`PatternFormatProps.rel`

***

### renderText()?[​](#rendertext "Direct link to renderText()?")

> `optional` **renderText**: (`formattedValue`, `otherProps`) => `ReactNode`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### formattedValue[​](#formattedvalue "Direct link to formattedValue")

`string`

##### otherProps[​](#otherprops "Direct link to otherProps")

`Partial`<`NumberFormatBase`>

#### Returns[​](#returns-2 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`PatternFormatProps.renderText`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`PatternFormatProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`PatternFormatProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`PatternFormatProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`PatternFormatProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`PatternFormatProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`PatternFormatProps.security`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`PatternFormatProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`PatternFormatProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`PatternFormatProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`PatternFormatProps.src`

***

### step?[​](#step "Direct link to step?")

> `optional` **step**: `string` | `number`

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`PatternFormatProps.step`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`PatternFormatProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`PatternFormatProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`PatternFormatProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`PatternFormatProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`PatternFormatProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`PatternFormatProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `"text"` | `"tel"` | `"password"`

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`PatternFormatProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`PatternFormatProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`PatternFormatProps.unselectable`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`PatternFormatProps.value`

***

### valueIsNumericString?[​](#valueisnumericstring "Direct link to valueIsNumericString?")

> `optional` **valueIsNumericString**: `boolean`

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`PatternFormatProps.valueIsNumericString`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`PatternFormatProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-322 "Direct link to Inherited from")

`PatternFormatProps.width`


---

# Interface: RsRadioGroupProps

Props for the RsRadioGroup component.

## Extends[​](#extends "Direct link to Extends")

* `RadioGroupProps`<`string`>

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `"default"` | `"picker"`

A radio group can have different appearances

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`RadioGroupProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`RadioGroupProps.as`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`RadioGroupProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`RadioGroupProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`RadioGroupProps.classPrefix`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string`

Initial value

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`RadioGroupProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Set the component to be disabled and cannot be entered

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`RadioGroupProps.disabled`

***

### inline?[​](#inline "Direct link to inline?")

> `optional` **inline**: `boolean`

Inline layout

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`RadioGroupProps.inline`

***

### items[​](#items "Direct link to items")

> **items**: [`LabeledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue)\[]

The items for the radio group.

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the radio group.

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name to use for form

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`RadioGroupProps.name`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`string`

the value.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides "Direct link to Overrides")

`RadioGroupProps.onChange`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`RadioGroupProps.plaintext`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`RadioGroupProps.readOnly`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`RadioGroupProps.style`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `string`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`RadioGroupProps.value`


---

# Interface: RsSearchProps

Props for the RsSearch component.

## Extends[​](#extends "Direct link to Extends")

* `InputPickerProps`.`LoadDataProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`InputPickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`InputPickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`InputPickerProps.block`

***

### cacheData?[​](#cachedata "Direct link to cacheData?")

> `optional` **cacheData**: `InputItemDataType`<`any`>\[]

Option to cache value when searching asynchronously

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`InputPickerProps.cacheData`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`InputPickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`InputPickerProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`InputPickerProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`InputPickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`InputPickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`InputPickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`InputPickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`InputPickerProps.containerPadding`

***

### creatable?[​](#creatable "Direct link to creatable?")

> `optional` **creatable**: `boolean`

Settings can create new options

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`InputPickerProps.creatable`

***

### data[​](#data "Direct link to data")

> **data**: `InputItemDataType`<`string` | `number`>\[]

The data of the component.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`InputPickerProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`InputPickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `any`

Initial value

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`InputPickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`InputPickerProps.disabled`

***

### disabledItemValues?[​](#disableditemvalues "Direct link to disabledItemValues?")

> `optional` **disabledItemValues**: `any`

Disabled items

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`InputPickerProps.disabledItemValues`

***

### disableVirtualized?[​](#disablevirtualized "Direct link to disableVirtualized?")

> `optional` **disableVirtualized**: `boolean`

Flag, if true, the virtualized will be disabled, false otherwise.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`LoadDataProps.disableVirtualized`

***

### groupBy?[​](#groupby "Direct link to groupBy?")

> `optional` **groupBy**: `string`

Set group condition key in data

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`InputPickerProps.groupBy`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`InputPickerProps.id`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the search input.

***

### labelKey?[​](#labelkey "Direct link to labelKey?")

> `optional` **labelKey**: `string`

The key to use for displaying the options in the data.

#### Default[​](#default-1 "Direct link to Default")

```
label
```

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`InputPickerProps.labelKey`

***

### listProps?[​](#listprops "Direct link to listProps?")

> `optional` **listProps**: `Partial`<`ListProps`<`any`>>

Virtualized List Props

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`InputPickerProps.listProps`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display an loading indicator on toggle button

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`InputPickerProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`InputPickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`InputPickerProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`InputPickerProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`InputPickerProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`InputPickerProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`InputPickerProps.menuStyle`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`InputPickerProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`Element`>

The `onBlur` attribute for the `input` element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`InputPickerProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the value.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides "Direct link to Overrides")

`InputPickerProps.onChange`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`InputPickerProps.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`InputPickerProps.onClose`

***

### onCreate()?[​](#oncreate "Direct link to onCreate()?")

> `optional` **onCreate**: (`value`, `item`, `event`) => `void`

Called when the option is created

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`any`

##### item[​](#item "Direct link to item")

`ItemDataType`

##### event[​](#event-1 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`InputPickerProps.onCreate`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`InputPickerProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`InputPickerProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`InputPickerProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`InputPickerProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`InputPickerProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`InputPickerProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`Element`>

The `onFocus` attribute for the `input` element.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`InputPickerProps.onFocus`

***

### onGroupTitleClick()?[​](#ongrouptitleclick "Direct link to onGroupTitleClick()?")

> `optional` **onGroupTitleClick**: (`event`) => `void`

Called after clicking the group title

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`InputPickerProps.onGroupTitleClick`

***

### onLoadData?[​](#onloaddata "Direct link to onLoadData?")

> `optional` **onLoadData**: [`LoadDataHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadDataHandler)

The callback function called when data should be load.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`LoadDataProps.onLoadData`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`InputPickerProps.onOpen`

***

### onSearch()?[​](#onsearch "Direct link to onSearch()?")

> `optional` **onSearch**: (`searchKeyword`, `event?`) => `void`

Called when searching

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword "Direct link to searchKeyword")

`string`

##### event?[​](#event-3 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`InputPickerProps.onSearch`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`value`, `item`, `event`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

##### item[​](#item-1 "Direct link to item")

`ItemDataType`<`any`>

##### event[​](#event-4 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`InputPickerProps.onSelect`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`InputPickerProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`InputPickerProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`InputPickerProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`InputPickerProps.plaintext`

***

### preload?[​](#preload "Direct link to preload?")

> `optional` **preload**: `boolean`

Flag, if true, the data will be loaded in advance, before opening the dropdown, false otherwise.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`LoadDataProps.preload`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`InputPickerProps.preventOverflow`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`InputPickerProps.readOnly`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-14 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`InputPickerProps.renderExtraFooter`

***

### renderMenu()?[​](#rendermenu "Direct link to renderMenu()?")

> `optional` **renderMenu**: (`menu`) => `ReactNode`

Customizing the Rendering Menu list

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### menu[​](#menu "Direct link to menu")

`ReactNode`

#### Returns[​](#returns-15 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`InputPickerProps.renderMenu`

***

### renderMenuGroup()?[​](#rendermenugroup "Direct link to renderMenuGroup()?")

> `optional` **renderMenuGroup**: (`title`, `item`) => `ReactNode`

Custom render menu group

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### title[​](#title "Direct link to title")

`ReactNode`

##### item[​](#item-2 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-16 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`InputPickerProps.renderMenuGroup`

***

### renderMenuItem()?[​](#rendermenuitem "Direct link to renderMenuItem()?")

> `optional` **renderMenuItem**: (`label`, `item`) => `ReactNode`

Custom render menuItems

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### label[​](#label-1 "Direct link to label")

`ReactNode`

##### item[​](#item-3 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-17 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`InputPickerProps.renderMenuItem`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`, `item`, `selectedElement`) => `ReactNode`

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

`any`

##### item[​](#item-4 "Direct link to item")

`ItemDataType`<`any`>

##### selectedElement[​](#selectedelement "Direct link to selectedElement")

`ReactNode`

#### Returns[​](#returns-18 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`InputPickerProps.renderValue`

***

### searchable?[​](#searchable "Direct link to searchable?")

> `optional` **searchable**: `boolean`

Whether dispaly search input box

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`InputPickerProps.searchable`

***

### searchBy()?[​](#searchby "Direct link to searchBy()?")

> `optional` **searchBy**: (`keyword`, `label`, `item`) => `boolean`

Custom search rules.

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### keyword[​](#keyword "Direct link to keyword")

`string`

##### label[​](#label-2 "Direct link to label")

`ReactNode`

##### item[​](#item-5 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-19 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`InputPickerProps.searchBy`

***

### shouldDisplayCreateOption()?[​](#shoulddisplaycreateoption "Direct link to shouldDisplayCreateOption()?")

> `optional` **shouldDisplayCreateOption**: (`searchKeyword`, `filteredData`) => `boolean`

Customize whether to display "Create option" action with given textbox value

By default, InputPicker hides "Create option" action when textbox value matches any filtered item's \[valueKey] property

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword-1 "Direct link to searchKeyword")

`string`

Value of the textbox

##### filteredData[​](#filtereddata "Direct link to filteredData")

`InputItemDataType`<`any`>\[]

The items filtered by the searchKeyword

#### Returns[​](#returns-20 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`InputPickerProps.shouldDisplayCreateOption`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`InputPickerProps.size`

***

### sort()?[​](#sort "Direct link to sort()?")

> `optional` **sort**: (`isGroup`) => (`a`, `b`) => `number`

Sort options

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### isGroup[​](#isgroup "Direct link to isGroup")

`boolean`

#### Returns[​](#returns-21 "Direct link to Returns")

> (`a`, `b`): `number`

##### Parameters[​](#parameters-19 "Direct link to Parameters")

###### a[​](#a "Direct link to a")

`any`

###### b[​](#b "Direct link to b")

`any`

##### Returns[​](#returns-22 "Direct link to Returns")

`number`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`InputPickerProps.sort`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`InputPickerProps.style`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`InputPickerProps.tabIndex`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`InputPickerProps.toggleAs`

***

### value?[​](#value-4 "Direct link to value?")

> `optional` **value**: `any`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`InputPickerProps.value`

***

### valueKey?[​](#valuekey "Direct link to valueKey?")

> `optional` **valueKey**: `string`

The key to use for setting the option value in the data.

#### Default[​](#default-2 "Direct link to Default")

```
value
```

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`InputPickerProps.valueKey`

***

### virtualized?[​](#virtualized "Direct link to virtualized?")

> `optional` **virtualized**: `boolean`

Whether using virtualized list

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`InputPickerProps.virtualized`


---

# Interface: RsStaticContentProps

Props for the RsStaticContent component.

## Properties[​](#properties "Direct link to Properties")

### allowHtml[​](#allowhtml "Direct link to allowHtml")

> **allowHtml**: `boolean`

Whether to allow HTML content.

***

### content[​](#content "Direct link to content")

> **content**: `string`

The content to display.


---

# Interface: RsTabProps

Props for the RsTab component.

## Extends[​](#extends "Direct link to Extends")

* `NavProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`NavProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`NavProps.accessKey`

***

### activeKey?[​](#activekey "Direct link to activeKey?")

> `optional` **activeKey**: `any`

The active key of the Nav component.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`NavProps.activeKey`

***

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `"default"` | `"tabs"` | `"subtle"` | `"pills"`

The appearance style of the Nav component.

#### Default[​](#default "Direct link to Default")

```
'default'
```

#### Version[​](#version "Direct link to Version")

'pills' is supported in version 5.68.0

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`NavProps.appearance`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`NavProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`NavProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`NavProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`NavProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`NavProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`NavProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`NavProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`NavProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`NavProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`NavProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`NavProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`NavProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`NavProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`NavProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`NavProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`NavProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`NavProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`NavProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`NavProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`NavProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`NavProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`NavProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`NavProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`NavProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`NavProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`NavProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`NavProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`NavProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`NavProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`NavProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`NavProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`NavProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`NavProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`NavProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`NavProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`NavProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`NavProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`NavProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`NavProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`NavProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`NavProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`NavProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`NavProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`NavProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`NavProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`NavProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`NavProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`NavProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`NavProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`NavProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`NavProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`NavProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`NavProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`NavProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`NavProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`NavProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`NavProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`NavProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`NavProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`NavProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`NavProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`NavProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`NavProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`NavProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`NavProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`NavProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`NavProps.datatype`

***

### defaultActiveKey?[​](#defaultactivekey "Direct link to defaultActiveKey?")

> `optional` **defaultActiveKey**: `any`

The default active key of the Nav component.

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`NavProps.defaultActiveKey`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`NavProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`NavProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`NavProps.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`NavProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`NavProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`NavProps.exportparts`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`NavProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`NavProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`NavProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`NavProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`NavProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`NavProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`NavProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`NavProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`NavProps.itemRef`

***

### items?[​](#items "Direct link to items?")

> `optional` **items**: [`RsTabItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/RsTabItem)\[]

Items for the tab.

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`NavProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`NavProps.itemType`

***

### justified?[​](#justified "Direct link to justified?")

> `optional` **justified**: `boolean`

Whether the Nav component is justified.

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`NavProps.justified`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`NavProps.lang`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`NavProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`NavProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`NavProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`NavProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`NavProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`NavProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`NavProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`NavProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`NavProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`NavProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`NavProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`NavProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`NavProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`NavProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`NavProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`NavProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`NavProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`NavProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`NavProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`NavProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`NavProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`NavProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`NavProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`NavProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`NavProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`NavProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`NavProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`NavProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`NavProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`NavProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`NavProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`NavProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`NavProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`NavProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`NavProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`NavProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`NavProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`NavProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`NavProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`NavProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`NavProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`NavProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`NavProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`NavProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`NavProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`NavProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`NavProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`NavProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`NavProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`NavProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`NavProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`NavProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`NavProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`NavProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`NavProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`NavProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`NavProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`NavProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`NavProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`NavProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`NavProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`NavProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`NavProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`NavProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`NavProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`NavProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`NavProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`NavProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`NavProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`NavProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`NavProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`NavProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`NavProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`NavProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`NavProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`NavProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`NavProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`NavProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`NavProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`NavProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`NavProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`NavProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`NavProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`NavProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`NavProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`NavProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`NavProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`NavProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`NavProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`NavProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`NavProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`NavProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`NavProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`NavProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`NavProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`NavProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`NavProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`NavProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`NavProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`NavProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`NavProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`NavProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`NavProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`NavProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`NavProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`NavProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`NavProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`NavProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`NavProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`NavProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`NavProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`NavProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`NavProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`NavProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`NavProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`NavProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`NavProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`NavProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`NavProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`NavProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`NavProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`NavProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`NavProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`NavProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`NavProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`NavProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`NavProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`NavProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`NavProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`NavProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`NavProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`NavProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`NavProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`NavProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`NavProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`NavProps.onSeekingCapture`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`eventKey`, `event`) => `void`

Event handler for selecting a Nav item.

#### Parameters[​](#parameters "Direct link to Parameters")

##### eventKey[​](#eventkey "Direct link to eventKey")

`any`

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`NavProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`NavProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`NavProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`NavProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`NavProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`NavProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`NavProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`NavProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`NavProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`NavProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`NavProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`NavProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`NavProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`NavProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`NavProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`NavProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`NavProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`NavProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`NavProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`NavProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`NavProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`NavProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`NavProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`NavProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`NavProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`NavProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`NavProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`NavProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`NavProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`NavProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`NavProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`NavProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`NavProps.onWheelCapture`

***

### pane[​](#pane "Direct link to pane")

> **pane**: `ReactNode`

Pane content for the tab.

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`NavProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`NavProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`NavProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`NavProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`NavProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`NavProps.property`

***

### pullRight?[​](#pullright "Direct link to pullRight?")

> `optional` **pullRight**: `boolean`

Whether the Nav component is pulled to the right.

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`NavProps.pullRight`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`NavProps.radioGroup`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`NavProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`NavProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`NavProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`NavProps.rev`

***

### reversed?[​](#reversed "Direct link to reversed?")

> `optional` **reversed**: `boolean`

Whether the Nav component is reversed.

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`NavProps.reversed`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`NavProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`NavProps.security`

***

### showNavigation?[​](#shownavigation "Direct link to showNavigation?")

> `optional` **showNavigation**: `boolean`

Whether to show navigation.

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`NavProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`NavProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`NavProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`NavProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`NavProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`NavProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`NavProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`NavProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`NavProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`NavProps.unselectable`

***

### vertical?[​](#vertical "Direct link to vertical?")

> `optional` **vertical**: `boolean`

Whether the Nav component is vertical.

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`NavProps.vertical`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`NavProps.vocab`


---

# Interface: RsTagPickerProps

Props for the RsTagPicker component.

## Extends[​](#extends "Direct link to Extends")

* `TagPickerProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`TagPickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`TagPickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TagPickerProps.block`

***

### cacheData?[​](#cachedata "Direct link to cacheData?")

> `optional` **cacheData**: `InputItemDataType`<`any`>\[]

Option to cache value when searching asynchronously

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`TagPickerProps.cacheData`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`TagPickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`TagPickerProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`TagPickerProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`TagPickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`TagPickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`TagPickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`TagPickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`TagPickerProps.containerPadding`

***

### creatable?[​](#creatable "Direct link to creatable?")

> `optional` **creatable**: `boolean`

Settings can create new options

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`TagPickerProps.creatable`

***

### data[​](#data "Direct link to data")

> **data**: `InputItemDataType`<`string` | `number`>\[]

The data of the component.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`TagPickerProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`TagPickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `any`

Initial value

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`TagPickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`TagPickerProps.disabled`

***

### disabledItemValues?[​](#disableditemvalues "Direct link to disabledItemValues?")

> `optional` **disabledItemValues**: `any`

Disabled items

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`TagPickerProps.disabledItemValues`

***

### groupBy?[​](#groupby "Direct link to groupBy?")

> `optional` **groupBy**: `string`

Set group condition key in data

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`TagPickerProps.groupBy`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`TagPickerProps.id`

***

### label[​](#label "Direct link to label")

> **label**: `string`

Label for the tag picker.

***

### labelKey?[​](#labelkey "Direct link to labelKey?")

> `optional` **labelKey**: `string`

The key to use for displaying the options in the data.

#### Default[​](#default-1 "Direct link to Default")

```
label
```

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`TagPickerProps.labelKey`

***

### listProps?[​](#listprops "Direct link to listProps?")

> `optional` **listProps**: `Partial`<`ListProps`<`any`>>

Virtualized List Props

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`TagPickerProps.listProps`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display an loading indicator on toggle button

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`TagPickerProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`InputPickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`TagPickerProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`TagPickerProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`TagPickerProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`TagPickerProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`TagPickerProps.menuStyle`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`TagPickerProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`Element`>

The `onBlur` attribute for the `input` element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`TagPickerProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the value.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides "Direct link to Overrides")

`TagPickerProps.onChange`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`TagPickerProps.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`TagPickerProps.onClose`

***

### onCreate()?[​](#oncreate "Direct link to onCreate()?")

> `optional` **onCreate**: (`value`, `item`, `event`) => `void`

Called when the option is created

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`any`

##### item[​](#item "Direct link to item")

`ItemDataType`

##### event[​](#event-1 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`TagPickerProps.onCreate`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`TagPickerProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`TagPickerProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`TagPickerProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`TagPickerProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`TagPickerProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`TagPickerProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`Element`>

The `onFocus` attribute for the `input` element.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`TagPickerProps.onFocus`

***

### onGroupTitleClick()?[​](#ongrouptitleclick "Direct link to onGroupTitleClick()?")

> `optional` **onGroupTitleClick**: (`event`) => `void`

Called after clicking the group title

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`TagPickerProps.onGroupTitleClick`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`TagPickerProps.onOpen`

***

### onSearch()?[​](#onsearch "Direct link to onSearch()?")

> `optional` **onSearch**: (`searchKeyword`, `event?`) => `void`

Called when searching

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword "Direct link to searchKeyword")

`string`

##### event?[​](#event-3 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`TagPickerProps.onSearch`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`value`, `item`, `event`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

##### item[​](#item-1 "Direct link to item")

`ItemDataType`<`any`>

##### event[​](#event-4 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`TagPickerProps.onSelect`

***

### onTagRemove()?[​](#ontagremove "Direct link to onTagRemove()?")

> `optional` **onTagRemove**: (`tag`, `event`) => `void`

Callback fired when a tag is removed.

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### tag[​](#tag "Direct link to tag")

`string`

##### event[​](#event-5 "Direct link to event")

`MouseEvent`

#### Returns[​](#returns-14 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`TagPickerProps.onTagRemove`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`TagPickerProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`TagPickerProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`TagPickerProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`TagPickerProps.plaintext`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`TagPickerProps.preventOverflow`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`TagPickerProps.readOnly`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-15 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`TagPickerProps.renderExtraFooter`

***

### renderMenu()?[​](#rendermenu "Direct link to renderMenu()?")

> `optional` **renderMenu**: (`menu`) => `ReactNode`

Customizing the Rendering Menu list

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### menu[​](#menu "Direct link to menu")

`ReactNode`

#### Returns[​](#returns-16 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`TagPickerProps.renderMenu`

***

### renderMenuGroup()?[​](#rendermenugroup "Direct link to renderMenuGroup()?")

> `optional` **renderMenuGroup**: (`title`, `item`) => `ReactNode`

Custom render menu group

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### title[​](#title "Direct link to title")

`ReactNode`

##### item[​](#item-2 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-17 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`TagPickerProps.renderMenuGroup`

***

### renderMenuItem()?[​](#rendermenuitem "Direct link to renderMenuItem()?")

> `optional` **renderMenuItem**: (`label`, `item`) => `ReactNode`

Custom render menuItems

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### label[​](#label-1 "Direct link to label")

`ReactNode`

##### item[​](#item-3 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-18 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`TagPickerProps.renderMenuItem`

***

### renderMenuItemCheckbox()?[​](#rendermenuitemcheckbox "Direct link to renderMenuItemCheckbox()?")

> `optional` **renderMenuItemCheckbox**: (`checkboxProps`) => `ReactNode`

Custom render checkbox on menu item

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### checkboxProps[​](#checkboxprops "Direct link to checkboxProps")

`CheckboxProps`

#### Returns[​](#returns-19 "Direct link to Returns")

`ReactNode`

#### Version[​](#version "Direct link to Version")

5.47.0

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`TagPickerProps.renderMenuItemCheckbox`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`values`, `items`, `selectedElement`) => `ReactNode`

Custom render selected items

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### values[​](#values "Direct link to values")

`any`\[]

##### items[​](#items "Direct link to items")

`ItemDataType`<`any`>\[]

##### selectedElement[​](#selectedelement "Direct link to selectedElement")

`ReactNode`

#### Returns[​](#returns-20 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`TagPickerProps.renderValue`

***

### searchable?[​](#searchable "Direct link to searchable?")

> `optional` **searchable**: `boolean`

Whether dispaly search input box

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`TagPickerProps.searchable`

***

### searchBy()?[​](#searchby "Direct link to searchBy()?")

> `optional` **searchBy**: (`keyword`, `label`, `item`) => `boolean`

Custom search rules.

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### keyword[​](#keyword "Direct link to keyword")

`string`

##### label[​](#label-2 "Direct link to label")

`ReactNode`

##### item[​](#item-4 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-21 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`TagPickerProps.searchBy`

***

### shouldDisplayCreateOption()?[​](#shoulddisplaycreateoption "Direct link to shouldDisplayCreateOption()?")

> `optional` **shouldDisplayCreateOption**: (`searchKeyword`, `filteredData`) => `boolean`

Customize whether to display "Create option" action with given textbox value

By default, InputPicker hides "Create option" action when textbox value matches any filtered item's \[valueKey] property

#### Parameters[​](#parameters-19 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword-1 "Direct link to searchKeyword")

`string`

Value of the textbox

##### filteredData[​](#filtereddata "Direct link to filteredData")

`InputItemDataType`<`any`>\[]

The items filtered by the searchKeyword

#### Returns[​](#returns-22 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`TagPickerProps.shouldDisplayCreateOption`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`TagPickerProps.size`

***

### sort()?[​](#sort "Direct link to sort()?")

> `optional` **sort**: (`isGroup`) => (`a`, `b`) => `number`

Sort options

#### Parameters[​](#parameters-20 "Direct link to Parameters")

##### isGroup[​](#isgroup "Direct link to isGroup")

`boolean`

#### Returns[​](#returns-23 "Direct link to Returns")

> (`a`, `b`): `number`

##### Parameters[​](#parameters-21 "Direct link to Parameters")

###### a[​](#a "Direct link to a")

`any`

###### b[​](#b "Direct link to b")

`any`

##### Returns[​](#returns-24 "Direct link to Returns")

`number`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`TagPickerProps.sort`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`TagPickerProps.style`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`TagPickerProps.tabIndex`

***

### tagProps?[​](#tagprops "Direct link to tagProps?")

> `optional` **tagProps**: `TagProps`

Tag related props.

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`TagPickerProps.tagProps`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`TagPickerProps.toggleAs`

***

### trigger?[​](#trigger "Direct link to trigger?")

> `optional` **trigger**: `TriggerType` | `TriggerType`\[]

Set the trigger for creating tags. only valid when creatable

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`TagPickerProps.trigger`

***

### value?[​](#value-3 "Direct link to value?")

> `optional` **value**: `any`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`TagPickerProps.value`

***

### valueKey?[​](#valuekey "Direct link to valueKey?")

> `optional` **valueKey**: `string`

The key to use for setting the option value in the data.

#### Default[​](#default-2 "Direct link to Default")

```
value
```

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`TagPickerProps.valueKey`

***

### virtualized?[​](#virtualized "Direct link to virtualized?")

> `optional` **virtualized**: `boolean`

Whether using virtualized list

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`TagPickerProps.virtualized`


---

# Interface: RsTextAreaProps

Props for the RsTextArea component.

## Extends[​](#extends "Direct link to Extends")

* `InputProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`InputProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`InputProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`InputProps.accessKey`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`InputProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`InputProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`InputProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`InputProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`InputProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`InputProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`InputProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`InputProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`InputProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`InputProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`InputProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`InputProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`InputProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`InputProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`InputProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`InputProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`InputProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`InputProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`InputProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`InputProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`InputProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`InputProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`InputProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`InputProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`InputProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`InputProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`InputProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`InputProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`InputProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`InputProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`InputProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`InputProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`InputProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`InputProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`InputProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`InputProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`InputProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`InputProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`InputProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`InputProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`InputProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`InputProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`InputProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`InputProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`InputProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`InputProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`InputProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`InputProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`InputProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`InputProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`InputProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`InputProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`InputProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`InputProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`InputProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`InputProps.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `HTMLInputAutoCompleteAttribute`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`InputProps.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`InputProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`InputProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`InputProps.autoSave`

***

### capture?[​](#capture "Direct link to capture?")

> `optional` **capture**: `boolean` | `"environment"` | `"user"`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`InputProps.capture`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`InputProps.checked`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`InputProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`InputProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`InputProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`InputProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`InputProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`InputProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`InputProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`InputProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`InputProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`InputProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`InputProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`InputProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`InputProps.disabled`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`InputProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`InputProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`InputProps.exportparts`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`InputProps.form`

***

### formAction?[​](#formaction "Direct link to formAction?")

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`InputProps.formAction`

***

### formEncType?[​](#formenctype "Direct link to formEncType?")

> `optional` **formEncType**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`InputProps.formEncType`

***

### formMethod?[​](#formmethod "Direct link to formMethod?")

> `optional` **formMethod**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`InputProps.formMethod`

***

### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?")

> `optional` **formNoValidate**: `boolean`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`InputProps.formNoValidate`

***

### formTarget?[​](#formtarget "Direct link to formTarget?")

> `optional` **formTarget**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`InputProps.formTarget`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`InputProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`InputProps.hidden`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

#### Overrides[​](#overrides "Direct link to Overrides")

`InputProps.htmlSize`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The HTML input id

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`InputProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`InputProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`InputProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`InputProps.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Ref of input element

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`InputProps.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`InputProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`InputProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`InputProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`InputProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`InputProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`InputProps.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the text area.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`InputProps.lang`

***

### list?[​](#list "Direct link to list?")

> `optional` **list**: `string`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`InputProps.list`

***

### max?[​](#max "Direct link to max?")

> `optional` **max**: `string` | `number`

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`InputProps.max`

***

### maxLength?[​](#maxlength "Direct link to maxLength?")

> `optional` **maxLength**: `number`

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`InputProps.maxLength`

***

### min?[​](#min "Direct link to min?")

> `optional` **min**: `string` | `number`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`InputProps.min`

***

### minLength?[​](#minlength "Direct link to minLength?")

> `optional` **minLength**: `number`

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`InputProps.minLength`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`InputProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`InputProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`InputProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`InputProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`InputProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`InputProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`InputProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`InputProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`InputProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`InputProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`InputProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`InputProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`InputProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`InputProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`InputProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`InputProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`InputProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`InputProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`InputProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`InputProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`InputProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`InputProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `PrependParameters`<`ChangeEventHandler`<`HTMLInputElement`>, \[`string`]>

The callback function in which value is changed.

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`InputProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`InputProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`InputProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`InputProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`InputProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`InputProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`InputProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`InputProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`InputProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`InputProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`InputProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`InputProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`InputProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`InputProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`InputProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`InputProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`InputProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`InputProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`InputProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`InputProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`InputProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`InputProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`InputProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`InputProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`InputProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`InputProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`InputProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`InputProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`InputProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`InputProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`InputProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`InputProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`InputProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`InputProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`InputProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`InputProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`InputProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`InputProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`InputProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`InputProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`InputProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`InputProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`InputProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`InputProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`InputProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`InputProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`InputProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`InputProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`InputProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`InputProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`InputProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`InputProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`InputProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`InputProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`InputProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`InputProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`InputProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`InputProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`InputProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`InputProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`InputProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`InputProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`InputProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`InputProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`InputProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`InputProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`InputProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`InputProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`InputProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`InputProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`InputProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`InputProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`InputProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`InputProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`InputProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`InputProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`InputProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`InputProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`InputProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`InputProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`InputProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`InputProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`InputProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`InputProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`InputProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`InputProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`InputProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`InputProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`InputProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`InputProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`InputProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`InputProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`InputProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`InputProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`InputProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`InputProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`InputProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`InputProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`InputProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`InputProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`InputProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`InputProps.onPointerUpCapture`

***

### onPressEnter?[​](#onpressenter "Direct link to onPressEnter?")

> `optional` **onPressEnter**: `KeyboardEventHandler`<`HTMLInputElement`>

Called on press enter

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`InputProps.onPressEnter`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`InputProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`InputProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`InputProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`InputProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`InputProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`InputProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`InputProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`InputProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`InputProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`InputProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`InputProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`InputProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`InputProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`InputProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`InputProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`InputProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`InputProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`InputProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`InputProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`InputProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`InputProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`InputProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`InputProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`InputProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`InputProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`InputProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`InputProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`InputProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`InputProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`InputProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`InputProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`InputProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`InputProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`InputProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`InputProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`InputProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`InputProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`InputProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`InputProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`InputProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`InputProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`InputProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`InputProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`InputProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`InputProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`InputProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`InputProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`InputProps.part`

***

### pattern?[​](#pattern "Direct link to pattern?")

> `optional` **pattern**: `string`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`InputProps.pattern`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`InputProps.placeholder`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`InputProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`InputProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`InputProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`InputProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`InputProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`InputProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`InputProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`InputProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`InputProps.rel`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`InputProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`InputProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`InputProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`InputProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`InputProps.role`

***

### rows[​](#rows "Direct link to rows")

> **rows**: `number`

The number of visible text lines.

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`InputProps.security`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`InputProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`InputProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`InputProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`InputProps.src`

***

### step?[​](#step "Direct link to step?")

> `optional` **step**: `string` | `number`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`InputProps.step`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`InputProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`InputProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`InputProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`InputProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`InputProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`InputProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `string`

The HTML input type

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`InputProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`InputProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`InputProps.unselectable`

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`InputProps.value`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`InputProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`InputProps.width`


---

# Interface: RsTimePickerProps

Props for the RsTimePicker component.

## Extends[​](#extends "Direct link to Extends")

* `Omit`<`DatePickerProps`, `"value"` | `"onChange"`>

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Omit.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Omit.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Omit.block`

***

### calendarDefaultDate?[​](#calendardefaultdate "Direct link to calendarDefaultDate?")

> `optional` **calendarDefaultDate**: `Date`

Calendar panel default presentation date and time

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Omit.calendarDefaultDate`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `null` | `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`Omit.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`Omit.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`Omit.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`Omit.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`Omit.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`Omit.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`Omit.containerPadding`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`Omit.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `null` | `Date`

Initial value

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`Omit.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Whether disabled the component

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`Omit.disabled`

***

### ~~disabledDate()?~~[​](#disableddate "Direct link to disableddate")

> `optional` **disabledDate**: (`date?`) => `boolean`

Whether to disable a date on the calendar view

#### Parameters[​](#parameters "Direct link to Parameters")

##### date?[​](#date "Direct link to date?")

`Date`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

date should be disabled (not selectable)

#### Deprecated[​](#deprecated "Direct link to Deprecated")

Use [shouldDisableDate](#shoulddisabledate) instead

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`Omit.disabledDate`

***

### ~~disabledHours()?~~[​](#disabledhours "Direct link to disabledhours")

> `optional` **disabledHours**: (`hour`, `date`) => `boolean`

Disabled hours

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### hour[​](#hour "Direct link to hour")

`number`

##### date[​](#date-1 "Direct link to date")

`Date`

#### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

Use [shouldDisableHour](#shoulddisablehour) instead

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`Omit.disabledHours`

***

### ~~disabledMinutes()?~~[​](#disabledminutes "Direct link to disabledminutes")

> `optional` **disabledMinutes**: (`minute`, `date`) => `boolean`

Disabled minutes

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### minute[​](#minute "Direct link to minute")

`number`

##### date[​](#date-2 "Direct link to date")

`Date`

#### Returns[​](#returns-2 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use [shouldDisableMinute](#shoulddisableminute) instead

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`Omit.disabledMinutes`

***

### ~~disabledSeconds()?~~[​](#disabledseconds "Direct link to disabledseconds")

> `optional` **disabledSeconds**: (`second`, `date`) => `boolean`

Disabled seconds

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### second[​](#second "Direct link to second")

`number`

##### date[​](#date-3 "Direct link to date")

`Date`

#### Returns[​](#returns-3 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use [shouldDisableSecond](#shoulddisablesecond) instead

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`Omit.disabledSeconds`

***

### editable?[​](#editable "Direct link to editable?")

> `optional` **editable**: `boolean`

Rendered as an input, the date can be entered via the keyboard

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`Omit.editable`

***

### format?[​](#format "Direct link to format?")

> `optional` **format**: `string`

Format date string

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`Omit.format`

***

### hideHours()?[​](#hidehours "Direct link to hideHours()?")

> `optional` **hideHours**: (`hour`, `date`) => `boolean`

Hide specific hour options

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hour[​](#hour-1 "Direct link to hour")

`number`

##### date[​](#date-4 "Direct link to date")

`Date`

#### Returns[​](#returns-4 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`Omit.hideHours`

***

### hideMinutes()?[​](#hideminutes "Direct link to hideMinutes()?")

> `optional` **hideMinutes**: (`minute`, `date`) => `boolean`

Hide specific minute options

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### minute[​](#minute-1 "Direct link to minute")

`number`

##### date[​](#date-5 "Direct link to date")

`Date`

#### Returns[​](#returns-5 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`Omit.hideMinutes`

***

### hideSeconds()?[​](#hideseconds "Direct link to hideSeconds()?")

> `optional` **hideSeconds**: (`second`, `date`) => `boolean`

Hide specific second options

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### second[​](#second-1 "Direct link to second")

`number`

##### date[​](#date-6 "Direct link to date")

`Date`

#### Returns[​](#returns-6 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`Omit.hideSeconds`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`Omit.id`

***

### ~~inline?~~[​](#inline "Direct link to inline")

> `optional` **inline**: `boolean`

#### Deprecated[​](#deprecated-4 "Direct link to Deprecated")

#### Overrides[​](#overrides "Direct link to Overrides")

`Omit.inline`

***

### isoWeek?[​](#isoweek "Direct link to isoWeek?")

> `optional` **isoWeek**: `boolean`

ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day

#### See[​](#see "Direct link to See")

<https://en.wikipedia.org/wiki/ISO_week_date>

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`Omit.isoWeek`

***

### label[​](#label "Direct link to label")

> **label**: `string`

Label for the time picker.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`Omit.label`

***

### limitEndYear?[​](#limitendyear "Direct link to limitEndYear?")

> `optional` **limitEndYear**: `number`

Set the upper limit of the available year relative to the current selection date

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`Omit.limitEndYear`

***

### limitStartYear?[​](#limitstartyear "Direct link to limitStartYear?")

> `optional` **limitStartYear**: `number`

Set the lower limit of the available year relative to the current selection date

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`Omit.limitStartYear`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display a loading state indicator

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`Omit.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`DatePickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`Omit.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`Omit.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`Omit.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`Omit.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`Omit.menuStyle`

***

### monthDropdownProps?[​](#monthdropdownprops "Direct link to monthDropdownProps?")

> `optional` **monthDropdownProps**: `MonthDropdownProps`

The props for the Month Dropdown component.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`Omit.monthDropdownProps`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`Omit.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`any`>

Called when the component is blurred.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`Omit.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`, `event`) => `void`

Callback when value changes.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`null` | `string`

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

***

### onChangeCalendarDate()?[​](#onchangecalendardate "Direct link to onChangeCalendarDate()?")

> `optional` **onChangeCalendarDate**: (`date`, `event?`) => `void`

Called when the calendar panel date changes

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### date[​](#date-7 "Direct link to date")

`Date`

##### event?[​](#event-1 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`Omit.onChangeCalendarDate`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`MouseEvent`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`Omit.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`Omit.onClose`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`Omit.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`Omit.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`Omit.onEntering`

***

### oneTap?[​](#onetap "Direct link to oneTap?")

> `optional` **oneTap**: `boolean`

One-click selection date

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`Omit.oneTap`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-14 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`Omit.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-15 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`Omit.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-16 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`Omit.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`any`>

Called when the component is focused.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`Omit.onFocus`

***

### onNextMonth()?[​](#onnextmonth "Direct link to onNextMonth()?")

> `optional` **onNextMonth**: (`date`) => `void`

Called after the next month

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### date[​](#date-8 "Direct link to date")

`Date`

#### Returns[​](#returns-17 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`Omit.onNextMonth`

***

### onOk()?[​](#onok "Direct link to onOk()?")

> `optional` **onOk**: (`date`, `event`) => `void`

Called after clicking the OK button

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### date[​](#date-9 "Direct link to date")

`Date`

##### event[​](#event-3 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-18 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`Omit.onOk`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-19 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`Omit.onOpen`

***

### onPrevMonth()?[​](#onprevmonth "Direct link to onPrevMonth()?")

> `optional` **onPrevMonth**: (`date`) => `void`

Called after the prev month

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### date[​](#date-10 "Direct link to date")

`Date`

#### Returns[​](#returns-20 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`Omit.onPrevMonth`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`date`, `event?`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-19 "Direct link to Parameters")

##### date[​](#date-11 "Direct link to date")

`Date`

##### event?[​](#event-4 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-21 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`Omit.onSelect`

***

### onShortcutClick()?[​](#onshortcutclick "Direct link to onShortcutClick()?")

> `optional` **onShortcutClick**: (`range`, `event`) => `void`

Called after clicking the shortcut button

#### Parameters[​](#parameters-20 "Direct link to Parameters")

##### range[​](#range "Direct link to range")

`RangeType`<`Date`>

##### event[​](#event-5 "Direct link to event")

`MouseEvent`

#### Returns[​](#returns-22 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`Omit.onShortcutClick`

***

### onToggleMonthDropdown()?[​](#ontogglemonthdropdown "Direct link to onToggleMonthDropdown()?")

> `optional` **onToggleMonthDropdown**: (`toggle`) => `void`

Called when opening the month view

#### Parameters[​](#parameters-21 "Direct link to Parameters")

##### toggle[​](#toggle "Direct link to toggle")

`boolean`

#### Returns[​](#returns-23 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`Omit.onToggleMonthDropdown`

***

### onToggleTimeDropdown()?[​](#ontoggletimedropdown "Direct link to onToggleTimeDropdown()?")

> `optional` **onToggleTimeDropdown**: (`toggle`) => `void`

Called when opening the time view

#### Parameters[​](#parameters-22 "Direct link to Parameters")

##### toggle[​](#toggle-1 "Direct link to toggle")

`boolean`

#### Returns[​](#returns-24 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`Omit.onToggleTimeDropdown`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`Omit.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`Omit.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`Omit.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Whether plaintext the component

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`Omit.plaintext`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`Omit.preventOverflow`

***

### ranges?[​](#ranges "Direct link to ranges?")

> `optional` **ranges**: `RangeType`<`Date`>\[]

Predefined date Ranges

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`Omit.ranges`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Whether read only the component

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`Omit.readOnly`

***

### renderCell()?[​](#rendercell "Direct link to renderCell()?")

> `optional` **renderCell**: (`date`) => `ReactNode`

Custom rendering calendar cell content.

#### Parameters[​](#parameters-23 "Direct link to Parameters")

##### date[​](#date-12 "Direct link to date")

`Date`

#### Returns[​](#returns-25 "Direct link to Returns")

`ReactNode`

#### Version[​](#version "Direct link to Version")

5.54.0

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`Omit.renderCell`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-26 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`Omit.renderExtraFooter`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`, `format`) => `string`

Custom rendering of the selected date.

#### Parameters[​](#parameters-24 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`Date`

##### format[​](#format-1 "Direct link to format")

`string`

#### Returns[​](#returns-27 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`Omit.renderValue`

***

### shouldDisableDate()?[​](#shoulddisabledate "Direct link to shouldDisableDate()?")

> `optional` **shouldDisableDate**: (`date`) => `boolean`

Whether a date on the calendar view should be disabled

#### Parameters[​](#parameters-25 "Direct link to Parameters")

##### date[​](#date-13 "Direct link to date")

`Date`

#### Returns[​](#returns-28 "Direct link to Returns")

`boolean`

date should be disabled (not selectable)

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`Omit.shouldDisableDate`

***

### shouldDisableHour()?[​](#shoulddisablehour "Direct link to shouldDisableHour()?")

> `optional` **shouldDisableHour**: (`hour`, `date`) => `boolean`

Disabled hours on the time view

#### Parameters[​](#parameters-26 "Direct link to Parameters")

##### hour[​](#hour-2 "Direct link to hour")

`number`

##### date[​](#date-14 "Direct link to date")

`Date`

#### Returns[​](#returns-29 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`Omit.shouldDisableHour`

***

### shouldDisableMinute()?[​](#shoulddisableminute "Direct link to shouldDisableMinute()?")

> `optional` **shouldDisableMinute**: (`minute`, `date`) => `boolean`

Disabled minutes on the time view

#### Parameters[​](#parameters-27 "Direct link to Parameters")

##### minute[​](#minute-2 "Direct link to minute")

`number`

##### date[​](#date-15 "Direct link to date")

`Date`

#### Returns[​](#returns-30 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`Omit.shouldDisableMinute`

***

### shouldDisableSecond()?[​](#shoulddisablesecond "Direct link to shouldDisableSecond()?")

> `optional` **shouldDisableSecond**: (`second`, `date`) => `boolean`

Disabled seconds on the time view

#### Parameters[​](#parameters-28 "Direct link to Parameters")

##### second[​](#second-2 "Direct link to second")

`number`

##### date[​](#date-16 "Direct link to date")

`Date`

#### Returns[​](#returns-31 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`Omit.shouldDisableSecond`

***

### ~~showMeridian?~~[​](#showmeridian "Direct link to showmeridian")

> `optional` **showMeridian**: `boolean`

#### Deprecated[​](#deprecated-5 "Direct link to Deprecated")

Use `showMeridiem` instead

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`Omit.showMeridian`

***

### showMeridiem?[​](#showmeridiem "Direct link to showMeridiem?")

> `optional` **showMeridiem**: `boolean`

Meridiem format for 12-hour time

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`Omit.showMeridiem`

***

### showWeekNumbers?[​](#showweeknumbers "Direct link to showWeekNumbers?")

> `optional` **showWeekNumbers**: `boolean`

Whether to show week numbers

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`Omit.showWeekNumbers`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`Omit.size`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`Omit.style`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`Omit.toggleAs`

***

### value?[​](#value-2 "Direct link to value?")

> `optional` **value**: `string`

Value of the time picker.

***

### weekStart?[​](#weekstart "Direct link to weekStart?")

> `optional` **weekStart**: `0` | `3` | `1` | `2` | `4` | `5` | `6`

The index of the first day of the week (0 - Sunday) If `isoWeek` is `true`, the value of `weekStart` is ignored.

#### Default[​](#default "Direct link to Default")

```
0
```

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`Omit.weekStart`


---

# Interface: RsTooltipProps

The properties of RsTooltip component.

## Extends[​](#extends "Direct link to Extends")

* [`WrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps)

## Properties[​](#properties "Direct link to Properties")

### children[​](#children "Direct link to children")

> **children**: `ReactNode`

The React child node.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`WrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps).[`children`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps#children)

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`WrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps).[`className`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps#classname)

***

### placement[​](#placement "Direct link to placement")

> **placement**: `Placement`

The placement of a tooltip.

***

### text[​](#text "Direct link to text")

> **text**: `string`

The tooltip text.

***

### trigger[​](#trigger "Direct link to trigger")

> **trigger**: `OverlayTriggerType`

The tooltip trigger.


---

# Interface: RsUploaderProps

Props for the RsUploader component.

## Extends[​](#extends "Direct link to Extends")

* `UploaderProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`UploaderProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

File types that can be accepted. See input accept Attribute

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`UploaderProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`UploaderProps.accessKey`

***

### action[​](#action "Direct link to action")

> **action**: `string`

Uploading URL

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`UploaderProps.action`

***

### active?[​](#active "Direct link to active?")

> `optional` **active**: `boolean`

A button can show it is currently the active user selection

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`UploaderProps.active`

***

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `Appearance`

A button can have different appearances.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`UploaderProps.appearance`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`UploaderProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`UploaderProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`UploaderProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`UploaderProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`UploaderProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`UploaderProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`UploaderProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`UploaderProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`UploaderProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`UploaderProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`UploaderProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`UploaderProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`UploaderProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`UploaderProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`UploaderProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`UploaderProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`UploaderProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`UploaderProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`UploaderProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`UploaderProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`UploaderProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`UploaderProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`UploaderProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`UploaderProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`UploaderProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`UploaderProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`UploaderProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`UploaderProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`UploaderProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`UploaderProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`UploaderProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`UploaderProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`UploaderProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`UploaderProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`UploaderProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`UploaderProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`UploaderProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`UploaderProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`UploaderProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`UploaderProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`UploaderProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`UploaderProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`UploaderProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`UploaderProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`UploaderProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`UploaderProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`UploaderProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`UploaderProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`UploaderProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`UploaderProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`UploaderProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`UploaderProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`UploaderProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`UploaderProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`UploaderProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`UploaderProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`UploaderProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`UploaderProps.autoSave`

***

### autoUpload?[​](#autoupload "Direct link to autoUpload?")

> `optional` **autoUpload**: `boolean`

Automatically upload files after selecting them

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`UploaderProps.autoUpload`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format button to appear inside a content block

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`UploaderProps.block`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactElement`<`unknown`, `string` | `JSXElementConstructor`<`any`>>

Primary content

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`UploaderProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`UploaderProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`UploaderProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `Color`

A button can have different colors

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`UploaderProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`UploaderProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`UploaderProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`UploaderProps.contextMenu`

***

### customElement[​](#customelement "Direct link to customElement")

> **customElement**: `boolean`

Whether to use a custom element for the uploader.

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`UploaderProps.dangerouslySetInnerHTML`

***

### data?[​](#data "Direct link to data?")

> `optional` **data**: `any`

Upload the parameters with

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`UploaderProps.data`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`UploaderProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`UploaderProps.defaultChecked`

***

### defaultFileList?[​](#defaultfilelist "Direct link to defaultFileList?")

> `optional` **defaultFileList**: `FileType`\[]

List of uploaded files

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`UploaderProps.defaultFileList`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`UploaderProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`UploaderProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Disabled upload button

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`UploaderProps.disabled`

***

### disabledFileItem?[​](#disabledfileitem "Direct link to disabledFileItem?")

> `optional` **disabledFileItem**: `boolean`

Disabled file item

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`UploaderProps.disabledFileItem`

***

### disableMultipart?[​](#disablemultipart "Direct link to disableMultipart?")

> `optional` **disableMultipart**: `boolean`

If 'true', disable using a multipart form for file upload and instead stream the file. Some APIs (e.g. Amazon S3) may expect the file to be streamed rather than sent via a form. Defaults to false.

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`UploaderProps.disableMultipart`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `boolean`

Supported Drag and drop upload \*

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`UploaderProps.draggable`

***

### endIcon?[​](#endicon "Direct link to endIcon?")

> `optional` **endIcon**: `ReactNode`

The icon element placed *after* the button text

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`UploaderProps.endIcon`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`UploaderProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`UploaderProps.exportparts`

***

### fileList?[​](#filelist "Direct link to fileList?")

> `optional` **fileList**: `FileType`\[]

List of uploaded files （Controlled）

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`UploaderProps.fileList`

***

### fileListVisible?[​](#filelistvisible "Direct link to fileListVisible?")

> `optional` **fileListVisible**: `boolean`

File list can be rendered

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`UploaderProps.fileListVisible`

***

### headers?[​](#headers "Direct link to headers?")

> `optional` **headers**: `any`

Set Upload request Header

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`UploaderProps.headers`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`UploaderProps.hidden`

***

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

Providing a `href` will render an `<a>` element, *styled* as a button

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`UploaderProps.href`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`UploaderProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`UploaderProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`UploaderProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`UploaderProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`UploaderProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`UploaderProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`UploaderProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`UploaderProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`UploaderProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`UploaderProps.itemType`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the uploader.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`UploaderProps.lang`

***

### listType?[​](#listtype "Direct link to listType?")

> `optional` **listType**: `"picture"` | `"text"` | `"picture-text"`

Upload list Style

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`UploaderProps.listType`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

A button can show a loading indicator

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`UploaderProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `UploaderLocale`

Custom locale

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`UploaderProps.locale`

***

### maxPreviewFileSize?[​](#maxpreviewfilesize "Direct link to maxPreviewFileSize?")

> `optional` **maxPreviewFileSize**: `number`

Max file size limit of the preview file

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`UploaderProps.maxPreviewFileSize`

***

### method?[​](#method "Direct link to method?")

> `optional` **method**: `string`

The http method of upload request

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`UploaderProps.method`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

Allow multiple file uploads

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`UploaderProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Upload the parameter name of the corresponding file

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`UploaderProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`UploaderProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`UploaderProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`UploaderProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`UploaderProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`UploaderProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`UploaderProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`UploaderProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`UploaderProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`UploaderProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`UploaderProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`UploaderProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`UploaderProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`UploaderProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`UploaderProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`UploaderProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`UploaderProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`UploaderProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`UploaderProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`UploaderProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`UploaderProps.onCanPlayThroughCapture`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`fileList`, `event`) => `void`

callback function that the upload queue has changed

#### Parameters[​](#parameters "Direct link to Parameters")

##### fileList[​](#filelist-1 "Direct link to fileList")

`FileType`\[]

##### event[​](#event "Direct link to event")

`MouseEvent`<`Element`, `MouseEvent`> | `ChangeEvent`<`Element`>

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`UploaderProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`UploaderProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`UploaderProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`UploaderProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`UploaderProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`UploaderProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`UploaderProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`UploaderProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`UploaderProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`UploaderProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`UploaderProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`UploaderProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`UploaderProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`UploaderProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`UploaderProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`UploaderProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`UploaderProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`UploaderProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`UploaderProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`UploaderProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`UploaderProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`UploaderProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`UploaderProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`UploaderProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`UploaderProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`UploaderProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`UploaderProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`UploaderProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`UploaderProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`UploaderProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`UploaderProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`UploaderProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`UploaderProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`UploaderProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`UploaderProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`UploaderProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`UploaderProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`UploaderProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`UploaderProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`UploaderProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`UploaderProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`UploaderProps.onEndedCapture`

***

### onError()?[​](#onerror "Direct link to onError()?")

> `optional` **onError**: (`status`, `file`, `event`, `xhr`) => `void`

Upload callback function with error

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### status[​](#status "Direct link to status")

`ErrorStatus`

##### file[​](#file "Direct link to file")

`FileType`

##### event[​](#event-1 "Direct link to event")

`ProgressEvent`

##### xhr[​](#xhr "Direct link to xhr")

`XMLHttpRequest`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`UploaderProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`UploaderProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`UploaderProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`UploaderProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`UploaderProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`UploaderProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`UploaderProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`UploaderProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`UploaderProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`UploaderProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`UploaderProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`UploaderProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`UploaderProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`UploaderProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`UploaderProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`UploaderProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`UploaderProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`UploaderProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`UploaderProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`UploaderProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`UploaderProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`UploaderProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`UploaderProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`UploaderProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`UploaderProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`UploaderProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`UploaderProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`UploaderProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`UploaderProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`UploaderProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`UploaderProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`UploaderProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`UploaderProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`UploaderProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`UploaderProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`UploaderProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`UploaderProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`UploaderProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`UploaderProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`UploaderProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`UploaderProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`UploaderProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`UploaderProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`UploaderProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`UploaderProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`UploaderProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`UploaderProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`UploaderProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`UploaderProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`UploaderProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`UploaderProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`UploaderProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`UploaderProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`UploaderProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`UploaderProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`UploaderProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`UploaderProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`UploaderProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`UploaderProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`UploaderProps.onPointerUpCapture`

***

### onPreview()?[​](#onpreview "Direct link to onPreview()?")

> `optional` **onPreview**: (`file`, `event`) => `void`

In the file list, click the callback function for the uploaded file

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### file[​](#file-1 "Direct link to file")

`FileType`

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`UploaderProps.onPreview`

***

### onProgress()?[​](#onprogress "Direct link to onProgress()?")

> `optional` **onProgress**: (`percent`, `file`, `event`, `xhr`) => `void`

Callback functions that upload progress change

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### percent[​](#percent "Direct link to percent")

`number`

##### file[​](#file-2 "Direct link to file")

`FileType`

##### event[​](#event-3 "Direct link to event")

`ProgressEvent`

##### xhr[​](#xhr-1 "Direct link to xhr")

`XMLHttpRequest`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`UploaderProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`UploaderProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`UploaderProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`UploaderProps.onRateChangeCapture`

***

### onRemove()?[​](#onremove "Direct link to onRemove()?")

> `optional` **onRemove**: (`file`) => `void`

In the file list, click the callback function to delete a file

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### file[​](#file-3 "Direct link to file")

`FileType`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`UploaderProps.onRemove`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`UploaderProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`UploaderProps.onResetCapture`

***

### onReupload()?[​](#onreupload "Direct link to onReupload()?")

> `optional` **onReupload**: (`file`) => `void`

In the file list, for uploading failed files, click the callback function to upload

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### file[​](#file-4 "Direct link to file")

`FileType`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`UploaderProps.onReupload`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`UploaderProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`UploaderProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`UploaderProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`UploaderProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`UploaderProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`UploaderProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`UploaderProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`UploaderProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`UploaderProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`UploaderProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`UploaderProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`UploaderProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`UploaderProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`UploaderProps.onSubmitCapture`

***

### onSuccess()?[​](#onsuccess "Direct link to onSuccess()?")

> `optional` **onSuccess**: (`response`, `file`, `event`, `xhr`) => `void`

callback function after successful upload

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### response[​](#response "Direct link to response")

`any`

##### file[​](#file-5 "Direct link to file")

`FileType`

##### event[​](#event-4 "Direct link to event")

`ProgressEvent`

##### xhr[​](#xhr-2 "Direct link to xhr")

`XMLHttpRequest`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`UploaderProps.onSuccess`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`UploaderProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`UploaderProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`UploaderProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`UploaderProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`UploaderProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`UploaderProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`UploaderProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`UploaderProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`UploaderProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`UploaderProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`UploaderProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`UploaderProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`UploaderProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`UploaderProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`UploaderProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`UploaderProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`UploaderProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`UploaderProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`UploaderProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`UploaderProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`UploaderProps.onTransitionStartCapture`

***

### onUpload()?[​](#onupload "Direct link to onUpload()?")

> `optional` **onUpload**: (`file`, `uploadData`, `xhr`) => `void`

The callback function that starts the upload file

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### file[​](#file-6 "Direct link to file")

`FileType`

##### uploadData[​](#uploaddata "Direct link to uploadData")

`any`

##### xhr[​](#xhr-3 "Direct link to xhr")

`XMLHttpRequest`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`UploaderProps.onUpload`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`UploaderProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`UploaderProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`UploaderProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`UploaderProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`UploaderProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`UploaderProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`UploaderProps.part`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`UploaderProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`UploaderProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`UploaderProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`UploaderProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`UploaderProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`UploaderProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`UploaderProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`UploaderProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`UploaderProps.rel`

***

### removable?[​](#removable "Direct link to removable?")

> `optional` **removable**: `boolean`

Removable list file

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`UploaderProps.removable`

***

### renderFileInfo()?[​](#renderfileinfo "Direct link to renderFileInfo()?")

> `optional` **renderFileInfo**: (`file`, `fileElement`) => `ReactNode`

Custom render file information

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### file[​](#file-7 "Direct link to file")

`FileType`

##### fileElement[​](#fileelement "Direct link to fileElement")

`ReactNode`

#### Returns[​](#returns-8 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`UploaderProps.renderFileInfo`

***

### renderThumbnail()?[​](#renderthumbnail "Direct link to renderThumbnail()?")

> `optional` **renderThumbnail**: (`file`, `thumbnail`) => `ReactNode`

Custom render thumbnail

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### file[​](#file-8 "Direct link to file")

`FileType`

##### thumbnail[​](#thumbnail "Direct link to thumbnail")

`ReactNode`

#### Returns[​](#returns-9 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`UploaderProps.renderThumbnail`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`UploaderProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`UploaderProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`UploaderProps.rev`

***

### ripple?[​](#ripple "Direct link to ripple?")

> `optional` **ripple**: `boolean`

Ripple after button click

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`UploaderProps.ripple`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`UploaderProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`UploaderProps.security`

***

### shouldQueueUpdate()?[​](#shouldqueueupdate "Direct link to shouldQueueUpdate()?")

> `optional` **shouldQueueUpdate**: (`fileList`, `newFile`) => `boolean` | `Promise`<`boolean`>

Allow the queue to be updated. After you select a file, update the checksum function before the upload file queue, and return false to not update

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### fileList[​](#filelist-2 "Direct link to fileList")

`FileType`\[]

##### newFile[​](#newfile "Direct link to newFile")

`FileType` | `FileType`\[]

#### Returns[​](#returns-10 "Direct link to Returns")

`boolean` | `Promise`<`boolean`>

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`UploaderProps.shouldQueueUpdate`

***

### shouldUpload()?[​](#shouldupload "Direct link to shouldUpload()?")

> `optional` **shouldUpload**: (`file`) => `boolean` | `Promise`<`boolean`>

Allow uploading of files. Check function before file upload, return false without uploading

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### file[​](#file-9 "Direct link to file")

`FileType`

#### Returns[​](#returns-11 "Direct link to Returns")

`boolean` | `Promise`<`boolean`>

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`UploaderProps.shouldUpload`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A button can have different sizes

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`UploaderProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`UploaderProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`UploaderProps.spellCheck`

***

### startIcon?[​](#starticon "Direct link to startIcon?")

> `optional` **startIcon**: `ReactNode`

The icon element placed *before* the button text

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`UploaderProps.startIcon`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`UploaderProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`UploaderProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`UploaderProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`UploaderProps.tabIndex`

***

### target?[​](#target "Direct link to target?")

> `optional` **target**: `string`

Where to display the linked URL

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`UploaderProps.target`

***

### timeout?[​](#timeout "Direct link to timeout?")

> `optional` **timeout**: `number`

Set upload timeout

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`UploaderProps.timeout`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`UploaderProps.title`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`UploaderProps.toggleAs`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`UploaderProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `"button"` | `"reset"` | `"submit"`

Defines HTML button type attribute

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`UploaderProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`UploaderProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`UploaderProps.unselectable`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`UploaderProps.vocab`

***

### withCredentials?[​](#withcredentials "Direct link to withCredentials?")

> `optional` **withCredentials**: `boolean`

Whether to carry cookies when uploading requests

#### Inherited from[​](#inherited-from-322 "Direct link to Inherited from")

`UploaderProps.withCredentials`


---

# Interface: RsWizardProps

Props for the RsWizard component.

## Extends[​](#extends "Direct link to Extends")

* `PropsWithChildren`<`any`>

## Indexable[​](#indexable "Direct link to Indexable")

\[`key`: `string`]: `any`

## Properties[​](#properties "Direct link to Properties")

### activeIndex?[​](#activeindex "Direct link to activeIndex?")

> `optional` **activeIndex**: `number`

Active step index.

***

### finishButtonLabel?[​](#finishbuttonlabel "Direct link to finishButtonLabel?")

> `optional` **finishButtonLabel**: `string`

Label for finish button.

***

### nextButtonLabel?[​](#nextbuttonlabel "Direct link to nextButtonLabel?")

> `optional` **nextButtonLabel**: `string`

Label for next button.

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`activeIndex?`) => `void`

Callback when step changes.

#### Parameters[​](#parameters "Direct link to Parameters")

##### activeIndex?[​](#activeindex-1 "Direct link to activeIndex?")

`number`

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### onFinish()?[​](#onfinish "Direct link to onFinish()?")

> `optional` **onFinish**: () => `void`

Callback when finish button is clicked.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### onNext()?[​](#onnext "Direct link to onNext()?")

> `optional` **onNext**: () => `void`

Callback when next button is clicked.

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

***

### onPrev()?[​](#onprev "Direct link to onPrev()?")

> `optional` **onPrev**: () => `void`

Callback when previous button is clicked.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### prevButtonLabel?[​](#prevbuttonlabel "Direct link to prevButtonLabel?")

> `optional` **prevButtonLabel**: `string`

Label for previous button.

***

### showSteps?[​](#showsteps "Direct link to showSteps?")

> `optional` **showSteps**: `boolean`

Whether to show steps.

***

### showStepsLabels?[​](#showstepslabels "Direct link to showStepsLabels?")

> `optional` **showStepsLabels**: `boolean`

Whether to show step labels.

***

### stepsNavigation?[​](#stepsnavigation "Direct link to stepsNavigation?")

> `optional` **stepsNavigation**: `"any"` | `"disable"` | `"onlyVisited"`

Navigation mode for steps.

***

### validateOnFinish[​](#validateonfinish "Direct link to validateOnFinish")

> **validateOnFinish**: `boolean`

Whether to validate on finish.

***

### validateOnNext[​](#validateonnext "Direct link to validateOnNext")

> **validateOnNext**: `boolean`

Whether to validate on next.

***

### verticalSteps?[​](#verticalsteps "Direct link to verticalSteps?")

> `optional` **verticalSteps**: `boolean`

Whether steps are vertical.


---

# Interface: RsWizardStepProps

Props for the RsWizardStep component.

## Properties[​](#properties "Direct link to Properties")

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

Label for the wizard step.


---

# Type Alias: LoadCallback()

> **LoadCallback** = (`newData`) => `void`

The callback function for loading data into the component.

## Parameters[​](#parameters "Direct link to Parameters")

### newData[​](#newdata "Direct link to newData")

`ItemDataType`\[]

the new data to be loaded into the component.

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Type Alias: LoadDataHandler()

> **LoadDataHandler** = (`searchKeyword`, `loadCallback`, `currentDataLength`) => `void`

Describes a function that is called when data is to be loaded into the component.

## Parameters[​](#parameters "Direct link to Parameters")

### searchKeyword[​](#searchkeyword "Direct link to searchKeyword")

`string`

the current search value.

### loadCallback[​](#loadcallback "Direct link to loadCallback")

[`LoadCallback`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadCallback)

the callback function called to set the data in the component.

### currentDataLength[​](#currentdatalength "Direct link to currentDataLength")

`number`

the length of the data already loaded.

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Type Alias: MenuItem

> **MenuItem** = `object`

Menu item for RsMenu component.

## Properties[​](#properties "Direct link to Properties")

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

The href for the menu item.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

The title for the menu item.


---

# Type Alias: RsTabItem

> **RsTabItem** = `object`

Tab item for RsTab component.

## Properties[​](#properties "Direct link to Properties")

### label[​](#label "Direct link to label")

> **label**: `string`

Label for the tab item.

***

### value[​](#value "Direct link to value")

> **value**: `string`

Value for the tab item.


---

# Variable: builderViewWithCss

> `const` **builderViewWithCss**: [`BuilderView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView)

An assembled set of rSuite components metadata, ready to be passed as a property to the FormBuilder. This view contains CSS loaders.


---

# Variable: components

> `const` **components**: [`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)\[]


---

# Variable: models

> `const` **models**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

An array of rSuite component metadata for use in FormViewer.


---

# Variable: rsAutoComplete

> `const` **rsAutoComplete**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsAutoCompleteProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsAutoCompleteProps)>


---

# Variable: rsBreadcrumb

> `const` **rsBreadcrumb**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsBreadcrumbProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbProps)>


---

# Variable: rsButton

> `const` **rsButton**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`ButtonProps`>


---

# Variable: rsCalendar

> `const` **rsCalendar**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsCalendarProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCalendarProps)>


---

# Variable: rsCard

> `const` **rsCard**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsCardProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCardProps)>


---

# Variable: rsCheckbox

> `const` **rsCheckbox**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`CheckboxProps`<`any`>>


---

# Variable: rsContainer

> `const` **rsContainer**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsContainerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsContainerProps) & `RefAttributes`<`any`>>


---

# Variable: rsDatePicker

> `const` **rsDatePicker**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsDatePickerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDatePickerProps)>


---

# Variable: rsDivider

> `const` **rsDivider**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`PropsWithChildren`<`ReplaceProps`<`ElementType`<`any`, keyof `IntrinsicElements`>, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `DividerProps`>>>


---

# Variable: rsDropdown

> `const` **rsDropdown**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsDropdownProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDropdownProps)>


---

# Variable: rsErrorMessage

> `const` **rsErrorMessage**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsErrorMessageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps)>

Metadata builder for rSuite-based error display component.


---

# Variable: rsHeader

> `const` **rsHeader**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsHeaderProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsHeaderProps)>


---

# Variable: rsImage

> `const` **rsImage**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsImageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsImageProps)>


---

# Variable: rsInput

> `const` **rsInput**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsInputProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsInputProps)>


---

# Variable: rsLabel

> `const` **rsLabel**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsLabelProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLabelProps)>


---

# Variable: rsLink

> `const` **rsLink**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsLinkProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLinkProps)>


---

# Variable: rsMenu

> `const` **rsMenu**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsMenuProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsMenuProps)>


---

# Variable: rsMessage

> `const` **rsMessage**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`Omit`<`any`, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `MessageProps`> & `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `MessageProps` & `object` & `object`>


---

# Variable: rsModal

> `const` **rsModal**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsModalProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalProps)>


---

# Variable: rsModalLayout

> `const` **rsModalLayout**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsModalLayoutProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalLayoutProps)>


---

# Variable: rsNumberFormat

> `const` **rsNumberFormat**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsNumberFormatProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsNumberFormatProps)>


---

# Variable: rsPatternFormat

> `const` **rsPatternFormat**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsPatternFormatProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsPatternFormatProps)>


---

# Variable: rsPlaceholderGraph

> `const` **rsPlaceholderGraph**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`PropsWithChildren`<`ReplaceProps`<`ElementType`<`any`, keyof `IntrinsicElements`>, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `PlaceholderGraphProps`>>>


---

# Variable: rsPlaceholderGrid

> `const` **rsPlaceholderGrid**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`PropsWithChildren`<`ReplaceProps`<`ElementType`<`any`, keyof `IntrinsicElements`>, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `PlaceholderGridProps`>>>


---

# Variable: rsPlaceholderParagraph

> `const` **rsPlaceholderParagraph**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`PropsWithChildren`<`ReplaceProps`<`ElementType`<`any`, keyof `IntrinsicElements`>, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `PlaceholderParagraphProps`>>>


---

# Variable: rsProgressCircle

> `const` **rsProgressCircle**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`PropsWithChildren`<`ReplaceProps`<`ElementType`<`any`, keyof `IntrinsicElements`>, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `ProgressCircleProps`>>>


---

# Variable: rsProgressLine

> `const` **rsProgressLine**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`PropsWithChildren`<`ReplaceProps`<`ElementType`<`any`, keyof `IntrinsicElements`>, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `ProgressLineProps`>>>


---

# Variable: rsRadioGroup

> `const` **rsRadioGroup**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsRadioGroupProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsRadioGroupProps)>


---

# Variable: rsSearch

> `const` **rsSearch**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsSearchProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsSearchProps)>


---

# Variable: rsStaticContent

> `const` **rsStaticContent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsStaticContentProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsStaticContentProps)>


---

# Variable: rsTab

> `const` **rsTab**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsTabProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTabProps)>


---

# Variable: rsTagPicker

> `const` **rsTagPicker**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsTagPickerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTagPickerProps)>


---

# Variable: rsTextArea

> `const` **rsTextArea**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsTextAreaProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTextAreaProps)>


---

# Variable: rsTimePicker

> `const` **rsTimePicker**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsTimePickerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTimePickerProps)>


---

# Variable: rsToggle

> `const` **rsToggle**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`Omit`<`any`, `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `ToggleProps`> & `WithAsProps`<`ElementType`<`any`, keyof `IntrinsicElements`>> & `ToggleProps` & `object` & `object`>


---

# Variable: rsTooltip

> `const` **rsTooltip**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsTooltipProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps)>

Metadata builder for rSuite-based tooltip display component.


---

# Variable: rSuiteComponents

> `const` **rSuiteComponents**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`any`>\[] = `[]`

An array of rSuite component metadata factories.


---

# Variable: rSuiteComponentsDescriptions

> `const` **rSuiteComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: rSuiteEnUsComponentsDescriptions

> **rSuiteEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.fields[​](#categoriesfields "Direct link to categories.fields")

> **categories.fields**: `object`

#### categories.fields.name[​](#categoriesfieldsname "Direct link to categories.fields.name")

> **categories.fields.name**: `string` = `"Fields"`

#### categories.modal[​](#categoriesmodal "Direct link to categories.modal")

> **categories.modal**: `object`

#### categories.modal.name[​](#categoriesmodalname "Direct link to categories.modal.name")

> **categories.modal.name**: `string` = `"Modal"`

#### categories.static[​](#categoriesstatic "Direct link to categories.static")

> **categories.static**: `object`

#### categories.static.name[​](#categoriesstaticname "Direct link to categories.static.name")

> **categories.static.name**: `string` = `"Static"`

#### categories.structure[​](#categoriesstructure "Direct link to categories.structure")

> **categories.structure**: `object`

#### categories.structure.name[​](#categoriesstructurename "Direct link to categories.structure.name")

> **categories.structure.name**: `string` = `"Structure"`

### commonProperties[​](#commonproperties "Direct link to commonProperties")

> **commonProperties**: `object`

#### commonProperties.backgroundColor[​](#commonpropertiesbackgroundcolor "Direct link to commonProperties.backgroundColor")

> **commonProperties.backgroundColor**: `object`

#### commonProperties.backgroundColor.description[​](#commonpropertiesbackgroundcolordescription "Direct link to commonProperties.backgroundColor.description")

> **commonProperties.backgroundColor.description**: `string` = `"The background color"`

#### commonProperties.backgroundColor.name[​](#commonpropertiesbackgroundcolorname "Direct link to commonProperties.backgroundColor.name")

> **commonProperties.backgroundColor.name**: `string` = `"Background"`

#### commonProperties.children[​](#commonpropertieschildren "Direct link to commonProperties.children")

> **commonProperties.children**: `object`

#### commonProperties.children.description[​](#commonpropertieschildrendescription "Direct link to commonProperties.children.description")

> **commonProperties.children.description**: `string` = `"Component children"`

#### commonProperties.children.name[​](#commonpropertieschildrenname "Direct link to commonProperties.children.name")

> **commonProperties.children.name**: `string` = `"Children"`

#### commonProperties.className[​](#commonpropertiesclassname "Direct link to commonProperties.className")

> **commonProperties.className**: `object`

#### commonProperties.className.description[​](#commonpropertiesclassnamedescription "Direct link to commonProperties.className.description")

> **commonProperties.className.description**: `string` = `"The CSS class name"`

#### commonProperties.className.name[​](#commonpropertiesclassnamename "Direct link to commonProperties.className.name")

> **commonProperties.className.name**: `string` = `"CSS class"`

#### commonProperties.disabled[​](#commonpropertiesdisabled "Direct link to commonProperties.disabled")

> **commonProperties.disabled**: `object`

#### commonProperties.disabled.description[​](#commonpropertiesdisableddescription "Direct link to commonProperties.disabled.description")

> **commonProperties.disabled.description**: `string` = `"Whether a component is disabled"`

#### commonProperties.disabled.name[​](#commonpropertiesdisabledname "Direct link to commonProperties.disabled.name")

> **commonProperties.disabled.name**: `string` = `"Disabled"`

#### commonProperties.fontSize[​](#commonpropertiesfontsize "Direct link to commonProperties.fontSize")

> **commonProperties.fontSize**: `object`

#### commonProperties.fontSize.description[​](#commonpropertiesfontsizedescription "Direct link to commonProperties.fontSize.description")

> **commonProperties.fontSize.description**: `string` = `"Font size"`

#### commonProperties.fontSize.name[​](#commonpropertiesfontsizename "Direct link to commonProperties.fontSize.name")

> **commonProperties.fontSize.name**: `string` = `"Font size"`

#### commonProperties.fontWeight[​](#commonpropertiesfontweight "Direct link to commonProperties.fontWeight")

> **commonProperties.fontWeight**: `object`

#### commonProperties.fontWeight.description[​](#commonpropertiesfontweightdescription "Direct link to commonProperties.fontWeight.description")

> **commonProperties.fontWeight.description**: `string` = `"Font weight"`

#### commonProperties.fontWeight.name[​](#commonpropertiesfontweightname "Direct link to commonProperties.fontWeight.name")

> **commonProperties.fontWeight.name**: `string` = `"Font weight"`

#### commonProperties.label[​](#commonpropertieslabel "Direct link to commonProperties.label")

> **commonProperties.label**: `object`

#### commonProperties.label.description[​](#commonpropertieslabeldescription "Direct link to commonProperties.label.description")

> **commonProperties.label.description**: `string` = `"The component label"`

#### commonProperties.label.name[​](#commonpropertieslabelname "Direct link to commonProperties.label.name")

> **commonProperties.label.name**: `string` = `"Label"`

#### commonProperties.placeholder[​](#commonpropertiesplaceholder "Direct link to commonProperties.placeholder")

> **commonProperties.placeholder**: `object`

#### commonProperties.placeholder.description[​](#commonpropertiesplaceholderdescription "Direct link to commonProperties.placeholder.description")

> **commonProperties.placeholder.description**: `string` = `"The placeholder"`

#### commonProperties.placeholder.name[​](#commonpropertiesplaceholdername "Direct link to commonProperties.placeholder.name")

> **commonProperties.placeholder.name**: `string` = `"Placeholder"`

#### commonProperties.placement[​](#commonpropertiesplacement "Direct link to commonProperties.placement")

> **commonProperties.placement**: `object`

#### commonProperties.placement.description[​](#commonpropertiesplacementdescription "Direct link to commonProperties.placement.description")

> **commonProperties.placement.description**: `string` = `"The placement of a component"`

#### commonProperties.placement.name[​](#commonpropertiesplacementname "Direct link to commonProperties.placement.name")

> **commonProperties.placement.name**: `string` = `"Placement"`

#### commonProperties.readOnly[​](#commonpropertiesreadonly "Direct link to commonProperties.readOnly")

> **commonProperties.readOnly**: `object`

#### commonProperties.readOnly.description[​](#commonpropertiesreadonlydescription "Direct link to commonProperties.readOnly.description")

> **commonProperties.readOnly.description**: `string` = `"Read-only flag"`

#### commonProperties.readOnly.name[​](#commonpropertiesreadonlyname "Direct link to commonProperties.readOnly.name")

> **commonProperties.readOnly.name**: `string` = `"Read only"`

#### commonProperties.size[​](#commonpropertiessize "Direct link to commonProperties.size")

> **commonProperties.size**: `object`

#### commonProperties.size.description[​](#commonpropertiessizedescription "Direct link to commonProperties.size.description")

> **commonProperties.size.description**: `string` = `"A component size"`

#### commonProperties.size.name[​](#commonpropertiessizename "Direct link to commonProperties.size.name")

> **commonProperties.size.name**: `string` = `"Size"`

#### commonProperties.textAlign[​](#commonpropertiestextalign "Direct link to commonProperties.textAlign")

> **commonProperties.textAlign**: `object`

#### commonProperties.textAlign.description[​](#commonpropertiestextaligndescription "Direct link to commonProperties.textAlign.description")

> **commonProperties.textAlign.description**: `string` = `"Text alignment"`

#### commonProperties.textAlign.name[​](#commonpropertiestextalignname "Direct link to commonProperties.textAlign.name")

> **commonProperties.textAlign.name**: `string` = `"Text align"`

#### commonProperties.value[​](#commonpropertiesvalue "Direct link to commonProperties.value")

> **commonProperties.value**: `object`

#### commonProperties.value.description[​](#commonpropertiesvaluedescription "Direct link to commonProperties.value.description")

> **commonProperties.value.description**: `string` = `"The current value (controlled)"`

#### commonProperties.value.name[​](#commonpropertiesvaluename "Direct link to commonProperties.value.name")

> **commonProperties.value.name**: `string` = `"Value"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.RsAutoComplete[​](#componentsrsautocomplete "Direct link to components.RsAutoComplete")

> **components.RsAutoComplete**: `object`

#### components.RsAutoComplete.description[​](#componentsrsautocompletedescription "Direct link to components.RsAutoComplete.description")

> **components.RsAutoComplete.description**: `string` = `"Provide auto-complete functionality for input box"`

#### components.RsAutoComplete.name[​](#componentsrsautocompletename "Direct link to components.RsAutoComplete.name")

> **components.RsAutoComplete.name**: `string` = `"AutoComplete"`

#### components.RsAutoComplete.props[​](#componentsrsautocompleteprops "Direct link to components.RsAutoComplete.props")

> **components.RsAutoComplete.props**: `object`

#### components.RsAutoComplete.props.classPrefix[​](#componentsrsautocompletepropsclassprefix "Direct link to components.RsAutoComplete.props.classPrefix")

> **components.RsAutoComplete.props.classPrefix**: `object`

#### components.RsAutoComplete.props.classPrefix.description[​](#componentsrsautocompletepropsclassprefixdescription "Direct link to components.RsAutoComplete.props.classPrefix.description")

> **components.RsAutoComplete.props.classPrefix.description**: `string` = `"The prefix of the component CSS class"`

#### components.RsAutoComplete.props.classPrefix.name[​](#componentsrsautocompletepropsclassprefixname "Direct link to components.RsAutoComplete.props.classPrefix.name")

> **components.RsAutoComplete.props.classPrefix.name**: `string` = `"Class prefix"`

#### components.RsAutoComplete.props.data[​](#componentsrsautocompletepropsdata "Direct link to components.RsAutoComplete.props.data")

> **components.RsAutoComplete.props.data**: `object`

#### components.RsAutoComplete.props.data.description[​](#componentsrsautocompletepropsdatadescription "Direct link to components.RsAutoComplete.props.data.description")

> **components.RsAutoComplete.props.data.description**: `string` = `"The data of component"`

#### components.RsAutoComplete.props.data.name[​](#componentsrsautocompletepropsdataname "Direct link to components.RsAutoComplete.props.data.name")

> **components.RsAutoComplete.props.data.name**: `string` = `"Data"`

#### components.RsAutoComplete.props.defaultValue[​](#componentsrsautocompletepropsdefaultvalue "Direct link to components.RsAutoComplete.props.defaultValue")

> **components.RsAutoComplete.props.defaultValue**: `object`

#### components.RsAutoComplete.props.defaultValue.description[​](#componentsrsautocompletepropsdefaultvaluedescription "Direct link to components.RsAutoComplete.props.defaultValue.description")

> **components.RsAutoComplete.props.defaultValue.description**: `string` = `"The default value (uncontrolled)"`

#### components.RsAutoComplete.props.defaultValue.name[​](#componentsrsautocompletepropsdefaultvaluename "Direct link to components.RsAutoComplete.props.defaultValue.name")

> **components.RsAutoComplete.props.defaultValue.name**: `string` = `"Default value"`

#### components.RsAutoComplete.props.filterBy[​](#componentsrsautocompletepropsfilterby "Direct link to components.RsAutoComplete.props.filterBy")

> **components.RsAutoComplete.props.filterBy**: `object`

#### components.RsAutoComplete.props.filterBy.description[​](#componentsrsautocompletepropsfilterbydescription "Direct link to components.RsAutoComplete.props.filterBy.description")

> **components.RsAutoComplete.props.filterBy.description**: `string` = `"Custom filter rules (will only display items that value is a substring of which by default)"`

#### components.RsAutoComplete.props.filterBy.name[​](#componentsrsautocompletepropsfilterbyname "Direct link to components.RsAutoComplete.props.filterBy.name")

> **components.RsAutoComplete.props.filterBy.name**: `string` = `"Filter by"`

#### components.RsAutoComplete.props.menuClassName[​](#componentsrsautocompletepropsmenuclassname "Direct link to components.RsAutoComplete.props.menuClassName")

> **components.RsAutoComplete.props.menuClassName**: `object`

#### components.RsAutoComplete.props.menuClassName.description[​](#componentsrsautocompletepropsmenuclassnamedescription "Direct link to components.RsAutoComplete.props.menuClassName.description")

> **components.RsAutoComplete.props.menuClassName.description**: `string` = `"A CSS class to apply to the Menu DOM"`

#### components.RsAutoComplete.props.menuClassName.name[​](#componentsrsautocompletepropsmenuclassnamename "Direct link to components.RsAutoComplete.props.menuClassName.name")

> **components.RsAutoComplete.props.menuClassName.name**: `string` = `"Menu class name"`

#### components.RsAutoComplete.props.onChange[​](#componentsrsautocompletepropsonchange "Direct link to components.RsAutoComplete.props.onChange")

> **components.RsAutoComplete.props.onChange**: `object`

#### components.RsAutoComplete.props.onChange.description[​](#componentsrsautocompletepropsonchangedescription "Direct link to components.RsAutoComplete.props.onChange.description")

> **components.RsAutoComplete.props.onChange.description**: `string` = `"Called when select an option or input value change, or value of input is changed"`

#### components.RsAutoComplete.props.onChange.name[​](#componentsrsautocompletepropsonchangename "Direct link to components.RsAutoComplete.props.onChange.name")

> **components.RsAutoComplete.props.onChange.name**: `string` = `"onChange"`

#### components.RsAutoComplete.props.onClose[​](#componentsrsautocompletepropsonclose "Direct link to components.RsAutoComplete.props.onClose")

> **components.RsAutoComplete.props.onClose**: `object`

#### components.RsAutoComplete.props.onClose.description[​](#componentsrsautocompletepropsonclosedescription "Direct link to components.RsAutoComplete.props.onClose.description")

> **components.RsAutoComplete.props.onClose.description**: `string` = `"Callback fired when hidden"`

#### components.RsAutoComplete.props.onClose.name[​](#componentsrsautocompletepropsonclosename "Direct link to components.RsAutoComplete.props.onClose.name")

> **components.RsAutoComplete.props.onClose.name**: `string` = `"onClose"`

#### components.RsAutoComplete.props.onEnter[​](#componentsrsautocompletepropsonenter "Direct link to components.RsAutoComplete.props.onEnter")

> **components.RsAutoComplete.props.onEnter**: `object`

#### components.RsAutoComplete.props.onEnter.description[​](#componentsrsautocompletepropsonenterdescription "Direct link to components.RsAutoComplete.props.onEnter.description")

> **components.RsAutoComplete.props.onEnter.description**: `string` = `"Callback fired before the overlay transitions in"`

#### components.RsAutoComplete.props.onEnter.name[​](#componentsrsautocompletepropsonentername "Direct link to components.RsAutoComplete.props.onEnter.name")

> **components.RsAutoComplete.props.onEnter.name**: `string` = `"onEnter"`

#### components.RsAutoComplete.props.onEntered[​](#componentsrsautocompletepropsonentered "Direct link to components.RsAutoComplete.props.onEntered")

> **components.RsAutoComplete.props.onEntered**: `object`

#### components.RsAutoComplete.props.onEntered.description[​](#componentsrsautocompletepropsonentereddescription "Direct link to components.RsAutoComplete.props.onEntered.description")

> **components.RsAutoComplete.props.onEntered.description**: `string` = `"Callback fired after the overlay finishes transitioning in"`

#### components.RsAutoComplete.props.onEntered.name[​](#componentsrsautocompletepropsonenteredname "Direct link to components.RsAutoComplete.props.onEntered.name")

> **components.RsAutoComplete.props.onEntered.name**: `string` = `"onEntered"`

#### components.RsAutoComplete.props.onEntering[​](#componentsrsautocompletepropsonentering "Direct link to components.RsAutoComplete.props.onEntering")

> **components.RsAutoComplete.props.onEntering**: `object`

#### components.RsAutoComplete.props.onEntering.description[​](#componentsrsautocompletepropsonenteringdescription "Direct link to components.RsAutoComplete.props.onEntering.description")

> **components.RsAutoComplete.props.onEntering.description**: `string` = `"Callback fired as the overlay begins to transition in"`

#### components.RsAutoComplete.props.onEntering.name[​](#componentsrsautocompletepropsonenteringname "Direct link to components.RsAutoComplete.props.onEntering.name")

> **components.RsAutoComplete.props.onEntering.name**: `string` = `"onEntering"`

#### components.RsAutoComplete.props.onExit[​](#componentsrsautocompletepropsonexit "Direct link to components.RsAutoComplete.props.onExit")

> **components.RsAutoComplete.props.onExit**: `object`

#### components.RsAutoComplete.props.onExit.description[​](#componentsrsautocompletepropsonexitdescription "Direct link to components.RsAutoComplete.props.onExit.description")

> **components.RsAutoComplete.props.onExit.description**: `string` = `"Callback fired right before the overlay transitions out"`

#### components.RsAutoComplete.props.onExit.name[​](#componentsrsautocompletepropsonexitname "Direct link to components.RsAutoComplete.props.onExit.name")

> **components.RsAutoComplete.props.onExit.name**: `string` = `"onExit"`

#### components.RsAutoComplete.props.onExited[​](#componentsrsautocompletepropsonexited "Direct link to components.RsAutoComplete.props.onExited")

> **components.RsAutoComplete.props.onExited**: `object`

#### components.RsAutoComplete.props.onExited.description[​](#componentsrsautocompletepropsonexiteddescription "Direct link to components.RsAutoComplete.props.onExited.description")

> **components.RsAutoComplete.props.onExited.description**: `string` = `"Callback fired after the overlay finishes transitioning out"`

#### components.RsAutoComplete.props.onExited.name[​](#componentsrsautocompletepropsonexitedname "Direct link to components.RsAutoComplete.props.onExited.name")

> **components.RsAutoComplete.props.onExited.name**: `string` = `"onExited"`

#### components.RsAutoComplete.props.onExiting[​](#componentsrsautocompletepropsonexiting "Direct link to components.RsAutoComplete.props.onExiting")

> **components.RsAutoComplete.props.onExiting**: `object`

#### components.RsAutoComplete.props.onExiting.description[​](#componentsrsautocompletepropsonexitingdescription "Direct link to components.RsAutoComplete.props.onExiting.description")

> **components.RsAutoComplete.props.onExiting.description**: `string` = `"Callback fired as the overlay begins to transition out"`

#### components.RsAutoComplete.props.onExiting.name[​](#componentsrsautocompletepropsonexitingname "Direct link to components.RsAutoComplete.props.onExiting.name")

> **components.RsAutoComplete.props.onExiting.name**: `string` = `"onExiting"`

#### components.RsAutoComplete.props.onSelect[​](#componentsrsautocompletepropsonselect "Direct link to components.RsAutoComplete.props.onSelect")

> **components.RsAutoComplete.props.onSelect**: `object`

#### components.RsAutoComplete.props.onSelect.description[​](#componentsrsautocompletepropsonselectdescription "Direct link to components.RsAutoComplete.props.onSelect.description")

> **components.RsAutoComplete.props.onSelect.description**: `string` = `"Called when a option is selected"`

#### components.RsAutoComplete.props.onSelect.name[​](#componentsrsautocompletepropsonselectname "Direct link to components.RsAutoComplete.props.onSelect.name")

> **components.RsAutoComplete.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsAutoComplete.props.renderMenu[​](#componentsrsautocompletepropsrendermenu "Direct link to components.RsAutoComplete.props.renderMenu")

> **components.RsAutoComplete.props.renderMenu**: `object`

#### components.RsAutoComplete.props.renderMenu.description[​](#componentsrsautocompletepropsrendermenudescription "Direct link to components.RsAutoComplete.props.renderMenu.description")

> **components.RsAutoComplete.props.renderMenu.description**: `string` = `"Customizing the Rendering Menu list"`

#### components.RsAutoComplete.props.renderMenu.name[​](#componentsrsautocompletepropsrendermenuname "Direct link to components.RsAutoComplete.props.renderMenu.name")

> **components.RsAutoComplete.props.renderMenu.name**: `string` = `"Render menu"`

#### components.RsAutoComplete.props.renderMenuItem[​](#componentsrsautocompletepropsrendermenuitem "Direct link to components.RsAutoComplete.props.renderMenuItem")

> **components.RsAutoComplete.props.renderMenuItem**: `object`

#### components.RsAutoComplete.props.renderMenuItem.description[​](#componentsrsautocompletepropsrendermenuitemdescription "Direct link to components.RsAutoComplete.props.renderMenuItem.description")

> **components.RsAutoComplete.props.renderMenuItem.description**: `string` = `"Custom render menu items"`

#### components.RsAutoComplete.props.renderMenuItem.name[​](#componentsrsautocompletepropsrendermenuitemname "Direct link to components.RsAutoComplete.props.renderMenuItem.name")

> **components.RsAutoComplete.props.renderMenuItem.name**: `string` = `"Render menu item"`

#### components.RsAutoComplete.props.selectOnEnter[​](#componentsrsautocompletepropsselectonenter "Direct link to components.RsAutoComplete.props.selectOnEnter")

> **components.RsAutoComplete.props.selectOnEnter**: `object`

#### components.RsAutoComplete.props.selectOnEnter.description[​](#componentsrsautocompletepropsselectonenterdescription "Direct link to components.RsAutoComplete.props.selectOnEnter.description")

> **components.RsAutoComplete.props.selectOnEnter.description**: `string` = `"When set to false, the Enter key selection function is invalid"`

#### components.RsAutoComplete.props.selectOnEnter.name[​](#componentsrsautocompletepropsselectonentername "Direct link to components.RsAutoComplete.props.selectOnEnter.name")

> **components.RsAutoComplete.props.selectOnEnter.name**: `string` = `"Select on Enter"`

#### components.RsBreadcrumb[​](#componentsrsbreadcrumb "Direct link to components.RsBreadcrumb")

> **components.RsBreadcrumb**: `object`

#### components.RsBreadcrumb.description[​](#componentsrsbreadcrumbdescription "Direct link to components.RsBreadcrumb.description")

> **components.RsBreadcrumb.description**: `string` = `"Used to display the current page path and quickly return to the history page"`

#### components.RsBreadcrumb.name[​](#componentsrsbreadcrumbname "Direct link to components.RsBreadcrumb.name")

> **components.RsBreadcrumb.name**: `string` = `"Breadcrumb"`

#### components.RsBreadcrumb.props[​](#componentsrsbreadcrumbprops "Direct link to components.RsBreadcrumb.props")

> **components.RsBreadcrumb.props**: `object`

#### components.RsBreadcrumb.props.items[​](#componentsrsbreadcrumbpropsitems "Direct link to components.RsBreadcrumb.props.items")

> **components.RsBreadcrumb.props.items**: `object`

#### components.RsBreadcrumb.props.items.description[​](#componentsrsbreadcrumbpropsitemsdescription "Direct link to components.RsBreadcrumb.props.items.description")

> **components.RsBreadcrumb.props.items.description**: `string` = `"Array of breadcrumb items to display"`

#### components.RsBreadcrumb.props.items.name[​](#componentsrsbreadcrumbpropsitemsname "Direct link to components.RsBreadcrumb.props.items.name")

> **components.RsBreadcrumb.props.items.name**: `string` = `"Items"`

#### components.RsBreadcrumb.props.maxItems[​](#componentsrsbreadcrumbpropsmaxitems "Direct link to components.RsBreadcrumb.props.maxItems")

> **components.RsBreadcrumb.props.maxItems**: `object`

#### components.RsBreadcrumb.props.maxItems.description[​](#componentsrsbreadcrumbpropsmaxitemsdescription "Direct link to components.RsBreadcrumb.props.maxItems.description")

> **components.RsBreadcrumb.props.maxItems.description**: `string` = `"Set the maximum number of breadcrumbs to display"`

#### components.RsBreadcrumb.props.maxItems.name[​](#componentsrsbreadcrumbpropsmaxitemsname "Direct link to components.RsBreadcrumb.props.maxItems.name")

> **components.RsBreadcrumb.props.maxItems.name**: `string` = `"Max items"`

#### components.RsBreadcrumb.props.onExpand[​](#componentsrsbreadcrumbpropsonexpand "Direct link to components.RsBreadcrumb.props.onExpand")

> **components.RsBreadcrumb.props.onExpand**: `object`

#### components.RsBreadcrumb.props.onExpand.description[​](#componentsrsbreadcrumbpropsonexpanddescription "Direct link to components.RsBreadcrumb.props.onExpand.description")

> **components.RsBreadcrumb.props.onExpand.description**: `string` = `"Callback function for clicking the ellipsis"`

#### components.RsBreadcrumb.props.onExpand.name[​](#componentsrsbreadcrumbpropsonexpandname "Direct link to components.RsBreadcrumb.props.onExpand.name")

> **components.RsBreadcrumb.props.onExpand.name**: `string` = `"onExpand"`

#### components.RsBreadcrumb.props.onItemClick[​](#componentsrsbreadcrumbpropsonitemclick "Direct link to components.RsBreadcrumb.props.onItemClick")

> **components.RsBreadcrumb.props.onItemClick**: `object`

#### components.RsBreadcrumb.props.onItemClick.description[​](#componentsrsbreadcrumbpropsonitemclickdescription "Direct link to components.RsBreadcrumb.props.onItemClick.description")

> **components.RsBreadcrumb.props.onItemClick.description**: `string` = `"Callback function when a breadcrumb item is clicked"`

#### components.RsBreadcrumb.props.onItemClick.name[​](#componentsrsbreadcrumbpropsonitemclickname "Direct link to components.RsBreadcrumb.props.onItemClick.name")

> **components.RsBreadcrumb.props.onItemClick.name**: `string` = `"onItemClick"`

#### components.RsBreadcrumb.props.separator[​](#componentsrsbreadcrumbpropsseparator "Direct link to components.RsBreadcrumb.props.separator")

> **components.RsBreadcrumb.props.separator**: `object`

#### components.RsBreadcrumb.props.separator.description[​](#componentsrsbreadcrumbpropsseparatordescription "Direct link to components.RsBreadcrumb.props.separator.description")

> **components.RsBreadcrumb.props.separator.description**: `string` = `"The separator between each breadcrumb item"`

#### components.RsBreadcrumb.props.separator.name[​](#componentsrsbreadcrumbpropsseparatorname "Direct link to components.RsBreadcrumb.props.separator.name")

> **components.RsBreadcrumb.props.separator.name**: `string` = `"Separator"`

#### components.RsButton[​](#componentsrsbutton "Direct link to components.RsButton")

> **components.RsButton**: `object`

#### components.RsButton.description[​](#componentsrsbuttondescription "Direct link to components.RsButton.description")

> **components.RsButton.description**: `string` = `"The button"`

#### components.RsButton.name[​](#componentsrsbuttonname "Direct link to components.RsButton.name")

> **components.RsButton.name**: `string` = `"Button"`

#### components.RsButton.props[​](#componentsrsbuttonprops "Direct link to components.RsButton.props")

> **components.RsButton.props**: `object`

#### components.RsButton.props.active[​](#componentsrsbuttonpropsactive "Direct link to components.RsButton.props.active")

> **components.RsButton.props.active**: `object`

#### components.RsButton.props.active.description[​](#componentsrsbuttonpropsactivedescription "Direct link to components.RsButton.props.active.description")

> **components.RsButton.props.active.description**: `string` = `"A button can show it is currently the active user selection"`

#### components.RsButton.props.active.name[​](#componentsrsbuttonpropsactivename "Direct link to components.RsButton.props.active.name")

> **components.RsButton.props.active.name**: `string` = `"Active"`

#### components.RsButton.props.appearance[​](#componentsrsbuttonpropsappearance "Direct link to components.RsButton.props.appearance")

> **components.RsButton.props.appearance**: `object`

#### components.RsButton.props.appearance.description[​](#componentsrsbuttonpropsappearancedescription "Direct link to components.RsButton.props.appearance.description")

> **components.RsButton.props.appearance.description**: `string` = `"A button can have different appearances"`

#### components.RsButton.props.appearance.name[​](#componentsrsbuttonpropsappearancename "Direct link to components.RsButton.props.appearance.name")

> **components.RsButton.props.appearance.name**: `string` = `"Appearance"`

#### components.RsButton.props.children[​](#componentsrsbuttonpropschildren "Direct link to components.RsButton.props.children")

> **components.RsButton.props.children**: `object`

#### components.RsButton.props.children.description[​](#componentsrsbuttonpropschildrendescription "Direct link to components.RsButton.props.children.description")

> **components.RsButton.props.children.description**: `string` = `"Primary content"`

#### components.RsButton.props.children.name[​](#componentsrsbuttonpropschildrenname "Direct link to components.RsButton.props.children.name")

> **components.RsButton.props.children.name**: `string` = `"Content"`

#### components.RsButton.props.disabled[​](#componentsrsbuttonpropsdisabled "Direct link to components.RsButton.props.disabled")

> **components.RsButton.props.disabled**: `object`

#### components.RsButton.props.disabled.description[​](#componentsrsbuttonpropsdisableddescription "Direct link to components.RsButton.props.disabled.description")

> **components.RsButton.props.disabled.description**: `string` = `"A button can show it is currently unable to be interacted with"`

#### components.RsButton.props.disabled.name[​](#componentsrsbuttonpropsdisabledname "Direct link to components.RsButton.props.disabled.name")

> **components.RsButton.props.disabled.name**: `string` = `"Disabled"`

#### components.RsButton.props.href[​](#componentsrsbuttonpropshref "Direct link to components.RsButton.props.href")

> **components.RsButton.props.href**: `object`

#### components.RsButton.props.href.description[​](#componentsrsbuttonpropshrefdescription "Direct link to components.RsButton.props.href.description")

> **components.RsButton.props.href.description**: `string` = `"Providing a href will render an <a> element"`

#### components.RsButton.props.href.name[​](#componentsrsbuttonpropshrefname "Direct link to components.RsButton.props.href.name")

> **components.RsButton.props.href.name**: `string` = `"Href"`

#### components.RsButton.props.loading[​](#componentsrsbuttonpropsloading "Direct link to components.RsButton.props.loading")

> **components.RsButton.props.loading**: `object`

#### components.RsButton.props.loading.description[​](#componentsrsbuttonpropsloadingdescription "Direct link to components.RsButton.props.loading.description")

> **components.RsButton.props.loading.description**: `string` = `"A button can show a loading indicator"`

#### components.RsButton.props.loading.name[​](#componentsrsbuttonpropsloadingname "Direct link to components.RsButton.props.loading.name")

> **components.RsButton.props.loading.name**: `string` = `"Loading"`

#### components.RsButton.props.onClick[​](#componentsrsbuttonpropsonclick "Direct link to components.RsButton.props.onClick")

> **components.RsButton.props.onClick**: `object`

#### components.RsButton.props.onClick.description[​](#componentsrsbuttonpropsonclickdescription "Direct link to components.RsButton.props.onClick.description")

> **components.RsButton.props.onClick.description**: `string` = `"Callback function when a button is clicked"`

#### components.RsButton.props.onClick.name[​](#componentsrsbuttonpropsonclickname "Direct link to components.RsButton.props.onClick.name")

> **components.RsButton.props.onClick.name**: `string` = `"onClick"`

#### components.RsCalendar[​](#componentsrscalendar "Direct link to components.RsCalendar")

> **components.RsCalendar**: `object`

#### components.RsCalendar.description[​](#componentsrscalendardescription "Direct link to components.RsCalendar.description")

> **components.RsCalendar.description**: `string` = `"A component that displays data by calendar"`

#### components.RsCalendar.name[​](#componentsrscalendarname "Direct link to components.RsCalendar.name")

> **components.RsCalendar.name**: `string` = `"Calendar"`

#### components.RsCalendar.props[​](#componentsrscalendarprops "Direct link to components.RsCalendar.props")

> **components.RsCalendar.props**: `object`

#### components.RsCalendar.props.bordered[​](#componentsrscalendarpropsbordered "Direct link to components.RsCalendar.props.bordered")

> **components.RsCalendar.props.bordered**: `object`

#### components.RsCalendar.props.bordered.description[​](#componentsrscalendarpropsbordereddescription "Direct link to components.RsCalendar.props.bordered.description")

> **components.RsCalendar.props.bordered.description**: `string` = `"Show border"`

#### components.RsCalendar.props.bordered.name[​](#componentsrscalendarpropsborderedname "Direct link to components.RsCalendar.props.bordered.name")

> **components.RsCalendar.props.bordered.name**: `string` = `"Bordered"`

#### components.RsCalendar.props.compact[​](#componentsrscalendarpropscompact "Direct link to components.RsCalendar.props.compact")

> **components.RsCalendar.props.compact**: `object`

#### components.RsCalendar.props.compact.description[​](#componentsrscalendarpropscompactdescription "Direct link to components.RsCalendar.props.compact.description")

> **components.RsCalendar.props.compact.description**: `string` = `"Display a compact calendar"`

#### components.RsCalendar.props.compact.name[​](#componentsrscalendarpropscompactname "Direct link to components.RsCalendar.props.compact.name")

> **components.RsCalendar.props.compact.name**: `string` = `"Compact"`

#### components.RsCalendar.props.defaultValue[​](#componentsrscalendarpropsdefaultvalue "Direct link to components.RsCalendar.props.defaultValue")

> **components.RsCalendar.props.defaultValue**: `object`

#### components.RsCalendar.props.defaultValue.description[​](#componentsrscalendarpropsdefaultvaluedescription "Direct link to components.RsCalendar.props.defaultValue.description")

> **components.RsCalendar.props.defaultValue.description**: `string` = `"Default value"`

#### components.RsCalendar.props.defaultValue.name[​](#componentsrscalendarpropsdefaultvaluename "Direct link to components.RsCalendar.props.defaultValue.name")

> **components.RsCalendar.props.defaultValue.name**: `string` = `"Default value"`

#### components.RsCalendar.props.isoWeek[​](#componentsrscalendarpropsisoweek "Direct link to components.RsCalendar.props.isoWeek")

> **components.RsCalendar.props.isoWeek**: `object`

#### components.RsCalendar.props.isoWeek.description[​](#componentsrscalendarpropsisoweekdescription "Direct link to components.RsCalendar.props.isoWeek.description")

> **components.RsCalendar.props.isoWeek.description**: `string` = `"ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day"`

#### components.RsCalendar.props.isoWeek.name[​](#componentsrscalendarpropsisoweekname "Direct link to components.RsCalendar.props.isoWeek.name")

> **components.RsCalendar.props.isoWeek.name**: `string` = `"ISO week"`

#### components.RsCalendar.props.onChange[​](#componentsrscalendarpropsonchange "Direct link to components.RsCalendar.props.onChange")

> **components.RsCalendar.props.onChange**: `object`

#### components.RsCalendar.props.onChange.description[​](#componentsrscalendarpropsonchangedescription "Direct link to components.RsCalendar.props.onChange.description")

> **components.RsCalendar.props.onChange.description**: `string` = `"Callback fired before the value changed"`

#### components.RsCalendar.props.onChange.name[​](#componentsrscalendarpropsonchangename "Direct link to components.RsCalendar.props.onChange.name")

> **components.RsCalendar.props.onChange.name**: `string` = `"onChange"`

#### components.RsCalendar.props.onSelect[​](#componentsrscalendarpropsonselect "Direct link to components.RsCalendar.props.onSelect")

> **components.RsCalendar.props.onSelect**: `object`

#### components.RsCalendar.props.onSelect.description[​](#componentsrscalendarpropsonselectdescription "Direct link to components.RsCalendar.props.onSelect.description")

> **components.RsCalendar.props.onSelect.description**: `string` = `"Callback fired before the date selected"`

#### components.RsCalendar.props.onSelect.name[​](#componentsrscalendarpropsonselectname "Direct link to components.RsCalendar.props.onSelect.name")

> **components.RsCalendar.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsCard[​](#componentsrscard "Direct link to components.RsCard")

> **components.RsCard**: `object`

#### components.RsCard.description[​](#componentsrscarddescription "Direct link to components.RsCard.description")

> **components.RsCard.description**: `string` = `"Card is a container component for displaying data,"`

#### components.RsCard.name[​](#componentsrscardname "Direct link to components.RsCard.name")

> **components.RsCard.name**: `string` = `"Card"`

#### components.RsCard.props[​](#componentsrscardprops "Direct link to components.RsCard.props")

> **components.RsCard.props**: `object`

#### components.RsCard.props.bodyFill[​](#componentsrscardpropsbodyfill "Direct link to components.RsCard.props.bodyFill")

> **components.RsCard.props.bodyFill**: `object`

#### components.RsCard.props.bodyFill.description[​](#componentsrscardpropsbodyfilldescription "Direct link to components.RsCard.props.bodyFill.description")

> **components.RsCard.props.bodyFill.description**: `string` = `"Content area filled with containers"`

#### components.RsCard.props.bodyFill.name[​](#componentsrscardpropsbodyfillname "Direct link to components.RsCard.props.bodyFill.name")

> **components.RsCard.props.bodyFill.name**: `string` = `"Body fill"`

#### components.RsCard.props.bordered[​](#componentsrscardpropsbordered "Direct link to components.RsCard.props.bordered")

> **components.RsCard.props.bordered**: `object`

#### components.RsCard.props.bordered.description[​](#componentsrscardpropsbordereddescription "Direct link to components.RsCard.props.bordered.description")

> **components.RsCard.props.bordered.description**: `string` = `"Show border"`

#### components.RsCard.props.bordered.name[​](#componentsrscardpropsborderedname "Direct link to components.RsCard.props.bordered.name")

> **components.RsCard.props.bordered.name**: `string` = `"Bordered"`

#### components.RsCard.props.children[​](#componentsrscardpropschildren "Direct link to components.RsCard.props.children")

> **components.RsCard.props.children**: `object`

#### components.RsCard.props.children.description[​](#componentsrscardpropschildrendescription "Direct link to components.RsCard.props.children.description")

> **components.RsCard.props.children.description**: `string` = `"Primary content"`

#### components.RsCard.props.children.name[​](#componentsrscardpropschildrenname "Direct link to components.RsCard.props.children.name")

> **components.RsCard.props.children.name**: `string` = `"Content"`

#### components.RsCard.props.collapsible[​](#componentsrscardpropscollapsible "Direct link to components.RsCard.props.collapsible")

> **components.RsCard.props.collapsible**: `object`

#### components.RsCard.props.collapsible.description[​](#componentsrscardpropscollapsibledescription "Direct link to components.RsCard.props.collapsible.description")

> **components.RsCard.props.collapsible.description**: `string` = `"Whether it is a collapsible panel"`

#### components.RsCard.props.collapsible.name[​](#componentsrscardpropscollapsiblename "Direct link to components.RsCard.props.collapsible.name")

> **components.RsCard.props.collapsible.name**: `string` = `"Collapsible"`

#### components.RsCard.props.defaultExpanded[​](#componentsrscardpropsdefaultexpanded "Direct link to components.RsCard.props.defaultExpanded")

> **components.RsCard.props.defaultExpanded**: `object`

#### components.RsCard.props.defaultExpanded.description[​](#componentsrscardpropsdefaultexpandeddescription "Direct link to components.RsCard.props.defaultExpanded.description")

> **components.RsCard.props.defaultExpanded.description**: `string` = `"Expand then panel by default"`

#### components.RsCard.props.defaultExpanded.name[​](#componentsrscardpropsdefaultexpandedname "Direct link to components.RsCard.props.defaultExpanded.name")

> **components.RsCard.props.defaultExpanded.name**: `string` = `"Default expanded"`

#### components.RsCard.props.eventKey[​](#componentsrscardpropseventkey "Direct link to components.RsCard.props.eventKey")

> **components.RsCard.props.eventKey**: `object`

#### components.RsCard.props.eventKey.description[​](#componentsrscardpropseventkeydescription "Direct link to components.RsCard.props.eventKey.description")

> **components.RsCard.props.eventKey.description**: `string` = `"The event key corresponding to the panel"`

#### components.RsCard.props.eventKey.name[​](#componentsrscardpropseventkeyname "Direct link to components.RsCard.props.eventKey.name")

> **components.RsCard.props.eventKey.name**: `string` = `"Event key"`

#### components.RsCard.props.header[​](#componentsrscardpropsheader "Direct link to components.RsCard.props.header")

> **components.RsCard.props.header**: `object`

#### components.RsCard.props.header.description[​](#componentsrscardpropsheaderdescription "Direct link to components.RsCard.props.header.description")

> **components.RsCard.props.header.description**: `string` = `"The head displays information"`

#### components.RsCard.props.header.name[​](#componentsrscardpropsheadername "Direct link to components.RsCard.props.header.name")

> **components.RsCard.props.header.name**: `string` = `"Header"`

#### components.RsCard.props.headerSize[​](#componentsrscardpropsheadersize "Direct link to components.RsCard.props.headerSize")

> **components.RsCard.props.headerSize**: `object`

#### components.RsCard.props.headerSize.description[​](#componentsrscardpropsheadersizedescription "Direct link to components.RsCard.props.headerSize.description")

> **components.RsCard.props.headerSize.description**: `string` = `"The header size for the panel header"`

#### components.RsCard.props.headerSize.name[​](#componentsrscardpropsheadersizename "Direct link to components.RsCard.props.headerSize.name")

> **components.RsCard.props.headerSize.name**: `string` = `"Header size"`

#### components.RsCard.props.onSelect[​](#componentsrscardpropsonselect "Direct link to components.RsCard.props.onSelect")

> **components.RsCard.props.onSelect**: `object`

#### components.RsCard.props.onSelect.description[​](#componentsrscardpropsonselectdescription "Direct link to components.RsCard.props.onSelect.description")

> **components.RsCard.props.onSelect.description**: `string` = `"Called when the panel is selected"`

#### components.RsCard.props.onSelect.name[​](#componentsrscardpropsonselectname "Direct link to components.RsCard.props.onSelect.name")

> **components.RsCard.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsCard.props.shaded[​](#componentsrscardpropsshaded "Direct link to components.RsCard.props.shaded")

> **components.RsCard.props.shaded**: `object`

#### components.RsCard.props.shaded.description[​](#componentsrscardpropsshadeddescription "Direct link to components.RsCard.props.shaded.description")

> **components.RsCard.props.shaded.description**: `string` = `"Whether there is a shadow"`

#### components.RsCard.props.shaded.name[​](#componentsrscardpropsshadedname "Direct link to components.RsCard.props.shaded.name")

> **components.RsCard.props.shaded.name**: `string` = `"Shaded"`

#### components.RsCard.props.title[​](#componentsrscardpropstitle "Direct link to components.RsCard.props.title")

> **components.RsCard.props.title**: `object`

#### components.RsCard.props.title.description[​](#componentsrscardpropstitledescription "Direct link to components.RsCard.props.title.description")

> **components.RsCard.props.title.description**: `string` = `"The title for the panel header"`

#### components.RsCard.props.title.name[​](#componentsrscardpropstitlename "Direct link to components.RsCard.props.title.name")

> **components.RsCard.props.title.name**: `string` = `"Title"`

#### components.RsCheckbox[​](#componentsrscheckbox "Direct link to components.RsCheckbox")

> **components.RsCheckbox**: `object`

#### components.RsCheckbox.description[​](#componentsrscheckboxdescription "Direct link to components.RsCheckbox.description")

> **components.RsCheckbox.description**: `string` = `"Check boxes are usually used in groups. Allow users to select one or more values from a set"`

#### components.RsCheckbox.name[​](#componentsrscheckboxname "Direct link to components.RsCheckbox.name")

> **components.RsCheckbox.name**: `string` = `"Checkbox"`

#### components.RsCheckbox.props[​](#componentsrscheckboxprops "Direct link to components.RsCheckbox.props")

> **components.RsCheckbox.props**: `object`

#### components.RsCheckbox.props.checked[​](#componentsrscheckboxpropschecked "Direct link to components.RsCheckbox.props.checked")

> **components.RsCheckbox.props.checked**: `object`

#### components.RsCheckbox.props.checked.description[​](#componentsrscheckboxpropscheckeddescription "Direct link to components.RsCheckbox.props.checked.description")

> **components.RsCheckbox.props.checked.description**: `string` = `"Specifies whether the checkbox is selected"`

#### components.RsCheckbox.props.checked.name[​](#componentsrscheckboxpropscheckedname "Direct link to components.RsCheckbox.props.checked.name")

> **components.RsCheckbox.props.checked.name**: `string` = `"Checked"`

#### components.RsCheckbox.props.children[​](#componentsrscheckboxpropschildren "Direct link to components.RsCheckbox.props.children")

> **components.RsCheckbox.props.children**: `object`

#### components.RsCheckbox.props.children.description[​](#componentsrscheckboxpropschildrendescription "Direct link to components.RsCheckbox.props.children.description")

> **components.RsCheckbox.props.children.description**: `string` = `"The component label"`

#### components.RsCheckbox.props.children.name[​](#componentsrscheckboxpropschildrenname "Direct link to components.RsCheckbox.props.children.name")

> **components.RsCheckbox.props.children.name**: `string` = `"Label"`

#### components.RsCheckbox.props.indeterminate[​](#componentsrscheckboxpropsindeterminate "Direct link to components.RsCheckbox.props.indeterminate")

> **components.RsCheckbox.props.indeterminate**: `object`

#### components.RsCheckbox.props.indeterminate.description[​](#componentsrscheckboxpropsindeterminatedescription "Direct link to components.RsCheckbox.props.indeterminate.description")

> **components.RsCheckbox.props.indeterminate.description**: `string` = `"When being a checkbox, setting styles after the child part is selected"`

#### components.RsCheckbox.props.indeterminate.name[​](#componentsrscheckboxpropsindeterminatename "Direct link to components.RsCheckbox.props.indeterminate.name")

> **components.RsCheckbox.props.indeterminate.name**: `string` = `"Indeterminate"`

#### components.RsCheckbox.props.inline[​](#componentsrscheckboxpropsinline "Direct link to components.RsCheckbox.props.inline")

> **components.RsCheckbox.props.inline**: `object`

#### components.RsCheckbox.props.inline.description[​](#componentsrscheckboxpropsinlinedescription "Direct link to components.RsCheckbox.props.inline.description")

> **components.RsCheckbox.props.inline.description**: `string` = `"Inline layout"`

#### components.RsCheckbox.props.inline.name[​](#componentsrscheckboxpropsinlinename "Direct link to components.RsCheckbox.props.inline.name")

> **components.RsCheckbox.props.inline.name**: `string` = `"Inline"`

#### components.RsCheckbox.props.onChange[​](#componentsrscheckboxpropsonchange "Direct link to components.RsCheckbox.props.onChange")

> **components.RsCheckbox.props.onChange**: `object`

#### components.RsCheckbox.props.onChange.description[​](#componentsrscheckboxpropsonchangedescription "Direct link to components.RsCheckbox.props.onChange.description")

> **components.RsCheckbox.props.onChange.description**: `string` = `"Called when the user attempts to change the checked state"`

#### components.RsCheckbox.props.onChange.name[​](#componentsrscheckboxpropsonchangename "Direct link to components.RsCheckbox.props.onChange.name")

> **components.RsCheckbox.props.onChange.name**: `string` = `"onChange"`

#### components.RsCheckbox.props.title[​](#componentsrscheckboxpropstitle "Direct link to components.RsCheckbox.props.title")

> **components.RsCheckbox.props.title**: `object`

#### components.RsCheckbox.props.title.description[​](#componentsrscheckboxpropstitledescription "Direct link to components.RsCheckbox.props.title.description")

> **components.RsCheckbox.props.title.description**: `string` = `"HTML title"`

#### components.RsCheckbox.props.title.name[​](#componentsrscheckboxpropstitlename "Direct link to components.RsCheckbox.props.title.name")

> **components.RsCheckbox.props.title.name**: `string` = `"Title"`

#### components.RsContainer[​](#componentsrscontainer "Direct link to components.RsContainer")

> **components.RsContainer**: `object`

#### components.RsContainer.description[​](#componentsrscontainerdescription "Direct link to components.RsContainer.description")

> **components.RsContainer.description**: `string` = `"Container is a layout component that can be used to wrap other components"`

#### components.RsContainer.name[​](#componentsrscontainername "Direct link to components.RsContainer.name")

> **components.RsContainer.name**: `string` = `"Container"`

#### components.RsContainer.props[​](#componentsrscontainerprops "Direct link to components.RsContainer.props")

> **components.RsContainer.props**: `object`

#### components.RsContainer.props.children[​](#componentsrscontainerpropschildren "Direct link to components.RsContainer.props.children")

> **components.RsContainer.props.children**: `object`

#### components.RsContainer.props.children.description[​](#componentsrscontainerpropschildrendescription "Direct link to components.RsContainer.props.children.description")

> **components.RsContainer.props.children.description**: `string` = `"Component children"`

#### components.RsContainer.props.children.name[​](#componentsrscontainerpropschildrenname "Direct link to components.RsContainer.props.children.name")

> **components.RsContainer.props.children.name**: `string` = `"Children"`

#### components.RsDatePicker[​](#componentsrsdatepicker "Direct link to components.RsDatePicker")

> **components.RsDatePicker**: `object`

#### components.RsDatePicker.description[​](#componentsrsdatepickerdescription "Direct link to components.RsDatePicker.description")

> **components.RsDatePicker.description**: `string` = `"DatePicker is a highly customizable component that allows users to enter and pick dates and times in different formats"`

#### components.RsDatePicker.name[​](#componentsrsdatepickername "Direct link to components.RsDatePicker.name")

> **components.RsDatePicker.name**: `string` = `"DatePicker"`

#### components.RsDatePicker.props[​](#componentsrsdatepickerprops "Direct link to components.RsDatePicker.props")

> **components.RsDatePicker.props**: `object`

#### components.RsDatePicker.props.appearance[​](#componentsrsdatepickerpropsappearance "Direct link to components.RsDatePicker.props.appearance")

> **components.RsDatePicker.props.appearance**: `object`

#### components.RsDatePicker.props.appearance.description[​](#componentsrsdatepickerpropsappearancedescription "Direct link to components.RsDatePicker.props.appearance.description")

> **components.RsDatePicker.props.appearance.description**: `string` = `"Set picker appearance"`

#### components.RsDatePicker.props.appearance.name[​](#componentsrsdatepickerpropsappearancename "Direct link to components.RsDatePicker.props.appearance.name")

> **components.RsDatePicker.props.appearance.name**: `string` = `"Appearance"`

#### components.RsDatePicker.props.calendarDefaultDate[​](#componentsrsdatepickerpropscalendardefaultdate "Direct link to components.RsDatePicker.props.calendarDefaultDate")

> **components.RsDatePicker.props.calendarDefaultDate**: `object`

#### components.RsDatePicker.props.calendarDefaultDate.description[​](#componentsrsdatepickerpropscalendardefaultdatedescription "Direct link to components.RsDatePicker.props.calendarDefaultDate.description")

> **components.RsDatePicker.props.calendarDefaultDate.description**: `string` = `"Calendar panel default presentation date and time"`

#### components.RsDatePicker.props.calendarDefaultDate.name[​](#componentsrsdatepickerpropscalendardefaultdatename "Direct link to components.RsDatePicker.props.calendarDefaultDate.name")

> **components.RsDatePicker.props.calendarDefaultDate.name**: `string` = `"Calendar default date"`

#### components.RsDatePicker.props.cleanable[​](#componentsrsdatepickerpropscleanable "Direct link to components.RsDatePicker.props.cleanable")

> **components.RsDatePicker.props.cleanable**: `object`

#### components.RsDatePicker.props.cleanable.description[​](#componentsrsdatepickerpropscleanabledescription "Direct link to components.RsDatePicker.props.cleanable.description")

> **components.RsDatePicker.props.cleanable.description**: `string` = `"Whether the selected value can be cleared"`

#### components.RsDatePicker.props.cleanable.name[​](#componentsrsdatepickerpropscleanablename "Direct link to components.RsDatePicker.props.cleanable.name")

> **components.RsDatePicker.props.cleanable.name**: `string` = `"Cleanable"`

#### components.RsDatePicker.props.defaultOpen[​](#componentsrsdatepickerpropsdefaultopen "Direct link to components.RsDatePicker.props.defaultOpen")

> **components.RsDatePicker.props.defaultOpen**: `object`

#### components.RsDatePicker.props.defaultOpen.description[​](#componentsrsdatepickerpropsdefaultopendescription "Direct link to components.RsDatePicker.props.defaultOpen.description")

> **components.RsDatePicker.props.defaultOpen.description**: `string` = `"Default value of open property"`

#### components.RsDatePicker.props.defaultOpen.name[​](#componentsrsdatepickerpropsdefaultopenname "Direct link to components.RsDatePicker.props.defaultOpen.name")

> **components.RsDatePicker.props.defaultOpen.name**: `string` = `"Default open"`

#### components.RsDatePicker.props.defaultValue[​](#componentsrsdatepickerpropsdefaultvalue "Direct link to components.RsDatePicker.props.defaultValue")

> **components.RsDatePicker.props.defaultValue**: `object`

#### components.RsDatePicker.props.defaultValue.description[​](#componentsrsdatepickerpropsdefaultvaluedescription "Direct link to components.RsDatePicker.props.defaultValue.description")

> **components.RsDatePicker.props.defaultValue.description**: `string` = `"Default value"`

#### components.RsDatePicker.props.defaultValue.name[​](#componentsrsdatepickerpropsdefaultvaluename "Direct link to components.RsDatePicker.props.defaultValue.name")

> **components.RsDatePicker.props.defaultValue.name**: `string` = `"Default value"`

#### components.RsDatePicker.props.editable[​](#componentsrsdatepickerpropseditable "Direct link to components.RsDatePicker.props.editable")

> **components.RsDatePicker.props.editable**: `object`

#### components.RsDatePicker.props.editable.description[​](#componentsrsdatepickerpropseditabledescription "Direct link to components.RsDatePicker.props.editable.description")

> **components.RsDatePicker.props.editable.description**: `string` = `"Rendered as an input, the date can be entered via the keyboard"`

#### components.RsDatePicker.props.editable.name[​](#componentsrsdatepickerpropseditablename "Direct link to components.RsDatePicker.props.editable.name")

> **components.RsDatePicker.props.editable.name**: `string` = `"Editable"`

#### components.RsDatePicker.props.format[​](#componentsrsdatepickerpropsformat "Direct link to components.RsDatePicker.props.format")

> **components.RsDatePicker.props.format**: `object`

#### components.RsDatePicker.props.format.description[​](#componentsrsdatepickerpropsformatdescription "Direct link to components.RsDatePicker.props.format.description")

> **components.RsDatePicker.props.format.description**: `string` = `"Format of the date when rendered in the input"`

#### components.RsDatePicker.props.format.name[​](#componentsrsdatepickerpropsformatname "Direct link to components.RsDatePicker.props.format.name")

> **components.RsDatePicker.props.format.name**: `string` = `"Format"`

#### components.RsDatePicker.props.isoWeek[​](#componentsrsdatepickerpropsisoweek "Direct link to components.RsDatePicker.props.isoWeek")

> **components.RsDatePicker.props.isoWeek**: `object`

#### components.RsDatePicker.props.isoWeek.description[​](#componentsrsdatepickerpropsisoweekdescription "Direct link to components.RsDatePicker.props.isoWeek.description")

> **components.RsDatePicker.props.isoWeek.description**: `string` = `"ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day"`

#### components.RsDatePicker.props.isoWeek.name[​](#componentsrsdatepickerpropsisoweekname "Direct link to components.RsDatePicker.props.isoWeek.name")

> **components.RsDatePicker.props.isoWeek.name**: `string` = `"ISO week"`

#### components.RsDatePicker.props.limitEndYear[​](#componentsrsdatepickerpropslimitendyear "Direct link to components.RsDatePicker.props.limitEndYear")

> **components.RsDatePicker.props.limitEndYear**: `object`

#### components.RsDatePicker.props.limitEndYear.description[​](#componentsrsdatepickerpropslimitendyeardescription "Direct link to components.RsDatePicker.props.limitEndYear.description")

> **components.RsDatePicker.props.limitEndYear.description**: `string` = `"Set the upper limit of the available year relative to the current selection date"`

#### components.RsDatePicker.props.limitEndYear.name[​](#componentsrsdatepickerpropslimitendyearname "Direct link to components.RsDatePicker.props.limitEndYear.name")

> **components.RsDatePicker.props.limitEndYear.name**: `string` = `"Limit end year"`

#### components.RsDatePicker.props.limitStartYear[​](#componentsrsdatepickerpropslimitstartyear "Direct link to components.RsDatePicker.props.limitStartYear")

> **components.RsDatePicker.props.limitStartYear**: `object`

#### components.RsDatePicker.props.limitStartYear.description[​](#componentsrsdatepickerpropslimitstartyeardescription "Direct link to components.RsDatePicker.props.limitStartYear.description")

> **components.RsDatePicker.props.limitStartYear.description**: `string` = `"Set the lower limit of the available year relative to the current selection date"`

#### components.RsDatePicker.props.limitStartYear.name[​](#componentsrsdatepickerpropslimitstartyearname "Direct link to components.RsDatePicker.props.limitStartYear.name")

> **components.RsDatePicker.props.limitStartYear.name**: `string` = `"Limit start year"`

#### components.RsDatePicker.props.onChange[​](#componentsrsdatepickerpropsonchange "Direct link to components.RsDatePicker.props.onChange")

> **components.RsDatePicker.props.onChange**: `object`

#### components.RsDatePicker.props.onChange.description[​](#componentsrsdatepickerpropsonchangedescription "Direct link to components.RsDatePicker.props.onChange.description")

> **components.RsDatePicker.props.onChange.description**: `string` = `"Callback fired when value changed"`

#### components.RsDatePicker.props.onChange.name[​](#componentsrsdatepickerpropsonchangename "Direct link to components.RsDatePicker.props.onChange.name")

> **components.RsDatePicker.props.onChange.name**: `string` = `"onChange"`

#### components.RsDatePicker.props.onChangeCalendarDate[​](#componentsrsdatepickerpropsonchangecalendardate "Direct link to components.RsDatePicker.props.onChangeCalendarDate")

> **components.RsDatePicker.props.onChangeCalendarDate**: `object`

#### components.RsDatePicker.props.onChangeCalendarDate.description[​](#componentsrsdatepickerpropsonchangecalendardatedescription "Direct link to components.RsDatePicker.props.onChangeCalendarDate.description")

> **components.RsDatePicker.props.onChangeCalendarDate.description**: `string` = `"Callback function that changes the calendar date"`

#### components.RsDatePicker.props.onChangeCalendarDate.name[​](#componentsrsdatepickerpropsonchangecalendardatename "Direct link to components.RsDatePicker.props.onChangeCalendarDate.name")

> **components.RsDatePicker.props.onChangeCalendarDate.name**: `string` = `"onChangeCalendarDate"`

#### components.RsDatePicker.props.onClean[​](#componentsrsdatepickerpropsonclean "Direct link to components.RsDatePicker.props.onClean")

> **components.RsDatePicker.props.onClean**: `object`

#### components.RsDatePicker.props.onClean.description[​](#componentsrsdatepickerpropsoncleandescription "Direct link to components.RsDatePicker.props.onClean.description")

> **components.RsDatePicker.props.onClean.description**: `string` = `"Callback fired when value clean"`

#### components.RsDatePicker.props.onClean.name[​](#componentsrsdatepickerpropsoncleanname "Direct link to components.RsDatePicker.props.onClean.name")

> **components.RsDatePicker.props.onClean.name**: `string` = `"onClean"`

#### components.RsDatePicker.props.onClose[​](#componentsrsdatepickerpropsonclose "Direct link to components.RsDatePicker.props.onClose")

> **components.RsDatePicker.props.onClose**: `object`

#### components.RsDatePicker.props.onClose.description[​](#componentsrsdatepickerpropsonclosedescription "Direct link to components.RsDatePicker.props.onClose.description")

> **components.RsDatePicker.props.onClose.description**: `string` = `"Callback fired when close component"`

#### components.RsDatePicker.props.onClose.name[​](#componentsrsdatepickerpropsonclosename "Direct link to components.RsDatePicker.props.onClose.name")

> **components.RsDatePicker.props.onClose.name**: `string` = `"onClose"`

#### components.RsDatePicker.props.onEnter[​](#componentsrsdatepickerpropsonenter "Direct link to components.RsDatePicker.props.onEnter")

> **components.RsDatePicker.props.onEnter**: `object`

#### components.RsDatePicker.props.onEnter.description[​](#componentsrsdatepickerpropsonenterdescription "Direct link to components.RsDatePicker.props.onEnter.description")

> **components.RsDatePicker.props.onEnter.description**: `string` = `"Callback fired before the overlay transitions in"`

#### components.RsDatePicker.props.onEnter.name[​](#componentsrsdatepickerpropsonentername "Direct link to components.RsDatePicker.props.onEnter.name")

> **components.RsDatePicker.props.onEnter.name**: `string` = `"onEnter"`

#### components.RsDatePicker.props.onEntered[​](#componentsrsdatepickerpropsonentered "Direct link to components.RsDatePicker.props.onEntered")

> **components.RsDatePicker.props.onEntered**: `object`

#### components.RsDatePicker.props.onEntered.description[​](#componentsrsdatepickerpropsonentereddescription "Direct link to components.RsDatePicker.props.onEntered.description")

> **components.RsDatePicker.props.onEntered.description**: `string` = `"Callback fired after the overlay finishes transitioning in"`

#### components.RsDatePicker.props.onEntered.name[​](#componentsrsdatepickerpropsonenteredname "Direct link to components.RsDatePicker.props.onEntered.name")

> **components.RsDatePicker.props.onEntered.name**: `string` = `"onEntered"`

#### components.RsDatePicker.props.onEntering[​](#componentsrsdatepickerpropsonentering "Direct link to components.RsDatePicker.props.onEntering")

> **components.RsDatePicker.props.onEntering**: `object`

#### components.RsDatePicker.props.onEntering.description[​](#componentsrsdatepickerpropsonenteringdescription "Direct link to components.RsDatePicker.props.onEntering.description")

> **components.RsDatePicker.props.onEntering.description**: `string` = `"Callback fired as the overlay begins to transition in"`

#### components.RsDatePicker.props.onEntering.name[​](#componentsrsdatepickerpropsonenteringname "Direct link to components.RsDatePicker.props.onEntering.name")

> **components.RsDatePicker.props.onEntering.name**: `string` = `"onEntering"`

#### components.RsDatePicker.props.oneTap[​](#componentsrsdatepickerpropsonetap "Direct link to components.RsDatePicker.props.oneTap")

> **components.RsDatePicker.props.oneTap**: `object`

#### components.RsDatePicker.props.oneTap.description[​](#componentsrsdatepickerpropsonetapdescription "Direct link to components.RsDatePicker.props.oneTap.description")

> **components.RsDatePicker.props.oneTap.description**: `string` = `"One-click selection date"`

#### components.RsDatePicker.props.oneTap.name[​](#componentsrsdatepickerpropsonetapname "Direct link to components.RsDatePicker.props.oneTap.name")

> **components.RsDatePicker.props.oneTap.name**: `string` = `"One tap"`

#### components.RsDatePicker.props.onExit[​](#componentsrsdatepickerpropsonexit "Direct link to components.RsDatePicker.props.onExit")

> **components.RsDatePicker.props.onExit**: `object`

#### components.RsDatePicker.props.onExit.description[​](#componentsrsdatepickerpropsonexitdescription "Direct link to components.RsDatePicker.props.onExit.description")

> **components.RsDatePicker.props.onExit.description**: `string` = `"Callback fired right before the overlay transitions out"`

#### components.RsDatePicker.props.onExit.name[​](#componentsrsdatepickerpropsonexitname "Direct link to components.RsDatePicker.props.onExit.name")

> **components.RsDatePicker.props.onExit.name**: `string` = `"onExit"`

#### components.RsDatePicker.props.onExited[​](#componentsrsdatepickerpropsonexited "Direct link to components.RsDatePicker.props.onExited")

> **components.RsDatePicker.props.onExited**: `object`

#### components.RsDatePicker.props.onExited.description[​](#componentsrsdatepickerpropsonexiteddescription "Direct link to components.RsDatePicker.props.onExited.description")

> **components.RsDatePicker.props.onExited.description**: `string` = `"Callback fired after the overlay finishes transitioning out"`

#### components.RsDatePicker.props.onExited.name[​](#componentsrsdatepickerpropsonexitedname "Direct link to components.RsDatePicker.props.onExited.name")

> **components.RsDatePicker.props.onExited.name**: `string` = `"onExited"`

#### components.RsDatePicker.props.onExiting[​](#componentsrsdatepickerpropsonexiting "Direct link to components.RsDatePicker.props.onExiting")

> **components.RsDatePicker.props.onExiting**: `object`

#### components.RsDatePicker.props.onExiting.description[​](#componentsrsdatepickerpropsonexitingdescription "Direct link to components.RsDatePicker.props.onExiting.description")

> **components.RsDatePicker.props.onExiting.description**: `string` = `"Callback fired as the overlay begins to transition out"`

#### components.RsDatePicker.props.onExiting.name[​](#componentsrsdatepickerpropsonexitingname "Direct link to components.RsDatePicker.props.onExiting.name")

> **components.RsDatePicker.props.onExiting.name**: `string` = `"onExiting"`

#### components.RsDatePicker.props.onNextMonth[​](#componentsrsdatepickerpropsonnextmonth "Direct link to components.RsDatePicker.props.onNextMonth")

> **components.RsDatePicker.props.onNextMonth**: `object`

#### components.RsDatePicker.props.onNextMonth.description[​](#componentsrsdatepickerpropsonnextmonthdescription "Direct link to components.RsDatePicker.props.onNextMonth.description")

> **components.RsDatePicker.props.onNextMonth.description**: `string` = `"Switch to the callback function for the next Month"`

#### components.RsDatePicker.props.onNextMonth.name[​](#componentsrsdatepickerpropsonnextmonthname "Direct link to components.RsDatePicker.props.onNextMonth.name")

> **components.RsDatePicker.props.onNextMonth.name**: `string` = `"onNextMonth"`

#### components.RsDatePicker.props.onOk[​](#componentsrsdatepickerpropsonok "Direct link to components.RsDatePicker.props.onOk")

> **components.RsDatePicker.props.onOk**: `object`

#### components.RsDatePicker.props.onOk.description[​](#componentsrsdatepickerpropsonokdescription "Direct link to components.RsDatePicker.props.onOk.description")

> **components.RsDatePicker.props.onOk.description**: `string` = `"Click the OK callback function"`

#### components.RsDatePicker.props.onOk.name[​](#componentsrsdatepickerpropsonokname "Direct link to components.RsDatePicker.props.onOk.name")

> **components.RsDatePicker.props.onOk.name**: `string` = `"onOk"`

#### components.RsDatePicker.props.onOpen[​](#componentsrsdatepickerpropsonopen "Direct link to components.RsDatePicker.props.onOpen")

> **components.RsDatePicker.props.onOpen**: `object`

#### components.RsDatePicker.props.onOpen.description[​](#componentsrsdatepickerpropsonopendescription "Direct link to components.RsDatePicker.props.onOpen.description")

> **components.RsDatePicker.props.onOpen.description**: `string` = `"Callback fired when open component"`

#### components.RsDatePicker.props.onOpen.name[​](#componentsrsdatepickerpropsonopenname "Direct link to components.RsDatePicker.props.onOpen.name")

> **components.RsDatePicker.props.onOpen.name**: `string` = `"onOpen"`

#### components.RsDatePicker.props.onPrevMonth[​](#componentsrsdatepickerpropsonprevmonth "Direct link to components.RsDatePicker.props.onPrevMonth")

> **components.RsDatePicker.props.onPrevMonth**: `object`

#### components.RsDatePicker.props.onPrevMonth.description[​](#componentsrsdatepickerpropsonprevmonthdescription "Direct link to components.RsDatePicker.props.onPrevMonth.description")

> **components.RsDatePicker.props.onPrevMonth.description**: `string` = `"Switch to the callback function for the previous Month"`

#### components.RsDatePicker.props.onPrevMonth.name[​](#componentsrsdatepickerpropsonprevmonthname "Direct link to components.RsDatePicker.props.onPrevMonth.name")

> **components.RsDatePicker.props.onPrevMonth.name**: `string` = `"onPrevMonth"`

#### components.RsDatePicker.props.onSelect[​](#componentsrsdatepickerpropsonselect "Direct link to components.RsDatePicker.props.onSelect")

> **components.RsDatePicker.props.onSelect**: `object`

#### components.RsDatePicker.props.onSelect.description[​](#componentsrsdatepickerpropsonselectdescription "Direct link to components.RsDatePicker.props.onSelect.description")

> **components.RsDatePicker.props.onSelect.description**: `string` = `"Callback fired when date or time is selected"`

#### components.RsDatePicker.props.onSelect.name[​](#componentsrsdatepickerpropsonselectname "Direct link to components.RsDatePicker.props.onSelect.name")

> **components.RsDatePicker.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsDatePicker.props.onToggleMonthDropdown[​](#componentsrsdatepickerpropsontogglemonthdropdown "Direct link to components.RsDatePicker.props.onToggleMonthDropdown")

> **components.RsDatePicker.props.onToggleMonthDropdown**: `object`

#### components.RsDatePicker.props.onToggleMonthDropdown.description[​](#componentsrsdatepickerpropsontogglemonthdropdowndescription "Direct link to components.RsDatePicker.props.onToggleMonthDropdown.description")

> **components.RsDatePicker.props.onToggleMonthDropdown.description**: `string` = `"Callback function that switches to the month view"`

#### components.RsDatePicker.props.onToggleMonthDropdown.name[​](#componentsrsdatepickerpropsontogglemonthdropdownname "Direct link to components.RsDatePicker.props.onToggleMonthDropdown.name")

> **components.RsDatePicker.props.onToggleMonthDropdown.name**: `string` = `"onToggleMonthDropdown"`

#### components.RsDatePicker.props.onToggleTimeDropdown[​](#componentsrsdatepickerpropsontoggletimedropdown "Direct link to components.RsDatePicker.props.onToggleTimeDropdown")

> **components.RsDatePicker.props.onToggleTimeDropdown**: `object`

#### components.RsDatePicker.props.onToggleTimeDropdown.description[​](#componentsrsdatepickerpropsontoggletimedropdowndescription "Direct link to components.RsDatePicker.props.onToggleTimeDropdown.description")

> **components.RsDatePicker.props.onToggleTimeDropdown.description**: `string` = `"Callback function that switches to the time view"`

#### components.RsDatePicker.props.onToggleTimeDropdown.name[​](#componentsrsdatepickerpropsontoggletimedropdownname "Direct link to components.RsDatePicker.props.onToggleTimeDropdown.name")

> **components.RsDatePicker.props.onToggleTimeDropdown.name**: `string` = `"onToggleTimeDropdown"`

#### components.RsDatePicker.props.open[​](#componentsrsdatepickerpropsopen "Direct link to components.RsDatePicker.props.open")

> **components.RsDatePicker.props.open**: `object`

#### components.RsDatePicker.props.open.description[​](#componentsrsdatepickerpropsopendescription "Direct link to components.RsDatePicker.props.open.description")

> **components.RsDatePicker.props.open.description**: `string` = `"Whether open the component"`

#### components.RsDatePicker.props.open.name[​](#componentsrsdatepickerpropsopenname "Direct link to components.RsDatePicker.props.open.name")

> **components.RsDatePicker.props.open.name**: `string` = `"Open"`

#### components.RsDatePicker.props.preventOverflow[​](#componentsrsdatepickerpropspreventoverflow "Direct link to components.RsDatePicker.props.preventOverflow")

> **components.RsDatePicker.props.preventOverflow**: `object`

#### components.RsDatePicker.props.preventOverflow\.description[​](#componentsrsdatepickerpropspreventoverflowdescription "Direct link to components.RsDatePicker.props.preventOverflow.description")

> **components.RsDatePicker.props.preventOverflow\.description**: `string` = `"Prevent floating element overflow"`

#### components.RsDatePicker.props.preventOverflow\.name[​](#componentsrsdatepickerpropspreventoverflowname "Direct link to components.RsDatePicker.props.preventOverflow.name")

> **components.RsDatePicker.props.preventOverflow\.name**: `string` = `"Prevent overflow"`

#### components.RsDatePicker.props.showMeridiem[​](#componentsrsdatepickerpropsshowmeridiem "Direct link to components.RsDatePicker.props.showMeridiem")

> **components.RsDatePicker.props.showMeridiem**: `object`

#### components.RsDatePicker.props.showMeridiem.description[​](#componentsrsdatepickerpropsshowmeridiemdescription "Direct link to components.RsDatePicker.props.showMeridiem.description")

> **components.RsDatePicker.props.showMeridiem.description**: `string` = `"Display hours in 12 format"`

#### components.RsDatePicker.props.showMeridiem.name[​](#componentsrsdatepickerpropsshowmeridiemname "Direct link to components.RsDatePicker.props.showMeridiem.name")

> **components.RsDatePicker.props.showMeridiem.name**: `string` = `"Show meridiem"`

#### components.RsDatePicker.props.showWeekNumbers[​](#componentsrsdatepickerpropsshowweeknumbers "Direct link to components.RsDatePicker.props.showWeekNumbers")

> **components.RsDatePicker.props.showWeekNumbers**: `object`

#### components.RsDatePicker.props.showWeekNumbers.description[​](#componentsrsdatepickerpropsshowweeknumbersdescription "Direct link to components.RsDatePicker.props.showWeekNumbers.description")

> **components.RsDatePicker.props.showWeekNumbers.description**: `string` = `"Whether to show week numbers"`

#### components.RsDatePicker.props.showWeekNumbers.name[​](#componentsrsdatepickerpropsshowweeknumbersname "Direct link to components.RsDatePicker.props.showWeekNumbers.name")

> **components.RsDatePicker.props.showWeekNumbers.name**: `string` = `"Show week numbers"`

#### components.RsDivider[​](#componentsrsdivider "Direct link to components.RsDivider")

> **components.RsDivider**: `object`

#### components.RsDivider.description[​](#componentsrsdividerdescription "Direct link to components.RsDivider.description")

> **components.RsDivider.description**: `string` = `"Divider are used to group content horizontally or vertically"`

#### components.RsDivider.name[​](#componentsrsdividername "Direct link to components.RsDivider.name")

> **components.RsDivider.name**: `string` = `"Divider"`

#### components.RsDivider.props[​](#componentsrsdividerprops "Direct link to components.RsDivider.props")

> **components.RsDivider.props**: `object`

#### components.RsDivider.props.children[​](#componentsrsdividerpropschildren "Direct link to components.RsDivider.props.children")

> **components.RsDivider.props.children**: `object`

#### components.RsDivider.props.children.description[​](#componentsrsdividerpropschildrendescription "Direct link to components.RsDivider.props.children.description")

> **components.RsDivider.props.children.description**: `string` = `"Set the text on the dividing line"`

#### components.RsDivider.props.children.name[​](#componentsrsdividerpropschildrenname "Direct link to components.RsDivider.props.children.name")

> **components.RsDivider.props.children.name**: `string` = `"Content"`

#### components.RsDivider.props.vertical[​](#componentsrsdividerpropsvertical "Direct link to components.RsDivider.props.vertical")

> **components.RsDivider.props.vertical**: `object`

#### components.RsDivider.props.vertical.description[​](#componentsrsdividerpropsverticaldescription "Direct link to components.RsDivider.props.vertical.description")

> **components.RsDivider.props.vertical.description**: `string` = `"Vertical dividing line"`

#### components.RsDivider.props.vertical.name[​](#componentsrsdividerpropsverticalname "Direct link to components.RsDivider.props.vertical.name")

> **components.RsDivider.props.vertical.name**: `string` = `"Vertical"`

#### components.RsDropdown[​](#componentsrsdropdown "Direct link to components.RsDropdown")

> **components.RsDropdown**: `object`

#### components.RsDropdown.description[​](#componentsrsdropdowndescription "Direct link to components.RsDropdown.description")

> **components.RsDropdown.description**: `string` = `"A drop-down menu is a navigation that uses selectpicker if you want to select a value"`

#### components.RsDropdown.name[​](#componentsrsdropdownname "Direct link to components.RsDropdown.name")

> **components.RsDropdown.name**: `string` = `"Dropdown"`

#### components.RsDropdown.props[​](#componentsrsdropdownprops "Direct link to components.RsDropdown.props")

> **components.RsDropdown.props**: `object`

#### components.RsDropdown.props.cleanable[​](#componentsrsdropdownpropscleanable "Direct link to components.RsDropdown.props.cleanable")

> **components.RsDropdown.props.cleanable**: `object`

#### components.RsDropdown.props.cleanable.description[​](#componentsrsdropdownpropscleanabledescription "Direct link to components.RsDropdown.props.cleanable.description")

> **components.RsDropdown.props.cleanable.description**: `string` = `"Whether the option can be emptied"`

#### components.RsDropdown.props.cleanable.name[​](#componentsrsdropdownpropscleanablename "Direct link to components.RsDropdown.props.cleanable.name")

> **components.RsDropdown.props.cleanable.name**: `string` = `"Cleanable"`

#### components.RsDropdown.props.creatable[​](#componentsrsdropdownpropscreatable "Direct link to components.RsDropdown.props.creatable")

> **components.RsDropdown.props.creatable**: `object`

#### components.RsDropdown.props.creatable.description[​](#componentsrsdropdownpropscreatabledescription "Direct link to components.RsDropdown.props.creatable.description")

> **components.RsDropdown.props.creatable.description**: `string` = `"Settings can create new options"`

#### components.RsDropdown.props.creatable.name[​](#componentsrsdropdownpropscreatablename "Direct link to components.RsDropdown.props.creatable.name")

> **components.RsDropdown.props.creatable.name**: `string` = `"Creatable"`

#### components.RsDropdown.props.data[​](#componentsrsdropdownpropsdata "Direct link to components.RsDropdown.props.data")

> **components.RsDropdown.props.data**: `object`

#### components.RsDropdown.props.data.description[​](#componentsrsdropdownpropsdatadescription "Direct link to components.RsDropdown.props.data.description")

> **components.RsDropdown.props.data.description**: `string` = `"Selectable data"`

#### components.RsDropdown.props.data.name[​](#componentsrsdropdownpropsdataname "Direct link to components.RsDropdown.props.data.name")

> **components.RsDropdown.props.data.name**: `string` = `"Data"`

#### components.RsDropdown.props.disableVirtualized[​](#componentsrsdropdownpropsdisablevirtualized "Direct link to components.RsDropdown.props.disableVirtualized")

> **components.RsDropdown.props.disableVirtualized**: `object`

#### components.RsDropdown.props.disableVirtualized.description[​](#componentsrsdropdownpropsdisablevirtualizeddescription "Direct link to components.RsDropdown.props.disableVirtualized.description")

> **components.RsDropdown.props.disableVirtualized.description**: `string` = `"Whether to disable virtualization"`

#### components.RsDropdown.props.disableVirtualized.name[​](#componentsrsdropdownpropsdisablevirtualizedname "Direct link to components.RsDropdown.props.disableVirtualized.name")

> **components.RsDropdown.props.disableVirtualized.name**: `string` = `"Disable virtualized"`

#### components.RsDropdown.props.groupBy[​](#componentsrsdropdownpropsgroupby "Direct link to components.RsDropdown.props.groupBy")

> **components.RsDropdown.props.groupBy**: `object`

#### components.RsDropdown.props.groupBy.description[​](#componentsrsdropdownpropsgroupbydescription "Direct link to components.RsDropdown.props.groupBy.description")

> **components.RsDropdown.props.groupBy.description**: `string` = `"Set grouping criteria 'key' in 'data'"`

#### components.RsDropdown.props.groupBy.name[​](#componentsrsdropdownpropsgroupbyname "Direct link to components.RsDropdown.props.groupBy.name")

> **components.RsDropdown.props.groupBy.name**: `string` = `"Group by"`

#### components.RsDropdown.props.onChange[​](#componentsrsdropdownpropsonchange "Direct link to components.RsDropdown.props.onChange")

> **components.RsDropdown.props.onChange**: `object`

#### components.RsDropdown.props.onChange.description[​](#componentsrsdropdownpropsonchangedescription "Direct link to components.RsDropdown.props.onChange.description")

> **components.RsDropdown.props.onChange.description**: `string` = `"Callback function when value changes"`

#### components.RsDropdown.props.onChange.name[​](#componentsrsdropdownpropsonchangename "Direct link to components.RsDropdown.props.onChange.name")

> **components.RsDropdown.props.onChange.name**: `string` = `"onChange"`

#### components.RsDropdown.props.onClean[​](#componentsrsdropdownpropsonclean "Direct link to components.RsDropdown.props.onClean")

> **components.RsDropdown.props.onClean**: `object`

#### components.RsDropdown.props.onClean.description[​](#componentsrsdropdownpropsoncleandescription "Direct link to components.RsDropdown.props.onClean.description")

> **components.RsDropdown.props.onClean.description**: `string` = `"The callback for clean"`

#### components.RsDropdown.props.onClean.name[​](#componentsrsdropdownpropsoncleanname "Direct link to components.RsDropdown.props.onClean.name")

> **components.RsDropdown.props.onClean.name**: `string` = `"onClean"`

#### components.RsDropdown.props.onClose[​](#componentsrsdropdownpropsonclose "Direct link to components.RsDropdown.props.onClose")

> **components.RsDropdown.props.onClose**: `object`

#### components.RsDropdown.props.onClose.description[​](#componentsrsdropdownpropsonclosedescription "Direct link to components.RsDropdown.props.onClose.description")

> **components.RsDropdown.props.onClose.description**: `string` = `"The callback for close"`

#### components.RsDropdown.props.onClose.name[​](#componentsrsdropdownpropsonclosename "Direct link to components.RsDropdown.props.onClose.name")

> **components.RsDropdown.props.onClose.name**: `string` = `"onClose"`

#### components.RsDropdown.props.onCreate[​](#componentsrsdropdownpropsoncreate "Direct link to components.RsDropdown.props.onCreate")

> **components.RsDropdown.props.onCreate**: `object`

#### components.RsDropdown.props.onCreate.description[​](#componentsrsdropdownpropsoncreatedescription "Direct link to components.RsDropdown.props.onCreate.description")

> **components.RsDropdown.props.onCreate.description**: `string` = `"The callback for create"`

#### components.RsDropdown.props.onCreate.name[​](#componentsrsdropdownpropsoncreatename "Direct link to components.RsDropdown.props.onCreate.name")

> **components.RsDropdown.props.onCreate.name**: `string` = `"onCreate"`

#### components.RsDropdown.props.onLoadData[​](#componentsrsdropdownpropsonloaddata "Direct link to components.RsDropdown.props.onLoadData")

> **components.RsDropdown.props.onLoadData**: `object`

#### components.RsDropdown.props.onLoadData.description[​](#componentsrsdropdownpropsonloaddatadescription "Direct link to components.RsDropdown.props.onLoadData.description")

> **components.RsDropdown.props.onLoadData.description**: `string` = `"The callback for loading data"`

#### components.RsDropdown.props.onLoadData.name[​](#componentsrsdropdownpropsonloaddataname "Direct link to components.RsDropdown.props.onLoadData.name")

> **components.RsDropdown.props.onLoadData.name**: `string` = `"onLoadData"`

#### components.RsDropdown.props.onSearch[​](#componentsrsdropdownpropsonsearch "Direct link to components.RsDropdown.props.onSearch")

> **components.RsDropdown.props.onSearch**: `object`

#### components.RsDropdown.props.onSearch.description[​](#componentsrsdropdownpropsonsearchdescription "Direct link to components.RsDropdown.props.onSearch.description")

> **components.RsDropdown.props.onSearch.description**: `string` = `"The callback for search"`

#### components.RsDropdown.props.onSearch.name[​](#componentsrsdropdownpropsonsearchname "Direct link to components.RsDropdown.props.onSearch.name")

> **components.RsDropdown.props.onSearch.name**: `string` = `"onSearch"`

#### components.RsDropdown.props.onSelect[​](#componentsrsdropdownpropsonselect "Direct link to components.RsDropdown.props.onSelect")

> **components.RsDropdown.props.onSelect**: `object`

#### components.RsDropdown.props.onSelect.description[​](#componentsrsdropdownpropsonselectdescription "Direct link to components.RsDropdown.props.onSelect.description")

> **components.RsDropdown.props.onSelect.description**: `string` = `"The callback for select"`

#### components.RsDropdown.props.onSelect.name[​](#componentsrsdropdownpropsonselectname "Direct link to components.RsDropdown.props.onSelect.name")

> **components.RsDropdown.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsDropdown.props.preload[​](#componentsrsdropdownpropspreload "Direct link to components.RsDropdown.props.preload")

> **components.RsDropdown.props.preload**: `object`

#### components.RsDropdown.props.preload.description[​](#componentsrsdropdownpropspreloaddescription "Direct link to components.RsDropdown.props.preload.description")

> **components.RsDropdown.props.preload.description**: `string` = `"Whether to preload data"`

#### components.RsDropdown.props.preload.name[​](#componentsrsdropdownpropspreloadname "Direct link to components.RsDropdown.props.preload.name")

> **components.RsDropdown.props.preload.name**: `string` = `"Preload"`

#### components.RsErrorMessage[​](#componentsrserrormessage "Direct link to components.RsErrorMessage")

> **components.RsErrorMessage**: `object`

#### components.RsErrorMessage.description[​](#componentsrserrormessagedescription "Direct link to components.RsErrorMessage.description")

> **components.RsErrorMessage.description**: `string` = `"The component that displays the validation message"`

#### components.RsErrorMessage.name[​](#componentsrserrormessagename "Direct link to components.RsErrorMessage.name")

> **components.RsErrorMessage.name**: `string` = `"Error message"`

#### components.RsHeader[​](#componentsrsheader "Direct link to components.RsHeader")

> **components.RsHeader**: `object`

#### components.RsHeader.description[​](#componentsrsheaderdescription "Direct link to components.RsHeader.description")

> **components.RsHeader.description**: `string` = `"Simple HTML header"`

#### components.RsHeader.name[​](#componentsrsheadername "Direct link to components.RsHeader.name")

> **components.RsHeader.name**: `string` = `"Header"`

#### components.RsHeader.props[​](#componentsrsheaderprops "Direct link to components.RsHeader.props")

> **components.RsHeader.props**: `object`

#### components.RsHeader.props.content[​](#componentsrsheaderpropscontent "Direct link to components.RsHeader.props.content")

> **components.RsHeader.props.content**: `object`

#### components.RsHeader.props.content.description[​](#componentsrsheaderpropscontentdescription "Direct link to components.RsHeader.props.content.description")

> **components.RsHeader.props.content.description**: `string` = `"Header text"`

#### components.RsHeader.props.content.name[​](#componentsrsheaderpropscontentname "Direct link to components.RsHeader.props.content.name")

> **components.RsHeader.props.content.name**: `string` = `"Content"`

#### components.RsHeader.props.headerSize[​](#componentsrsheaderpropsheadersize "Direct link to components.RsHeader.props.headerSize")

> **components.RsHeader.props.headerSize**: `object`

#### components.RsHeader.props.headerSize.description[​](#componentsrsheaderpropsheadersizedescription "Direct link to components.RsHeader.props.headerSize.description")

> **components.RsHeader.props.headerSize.description**: `string` = `"Header level"`

#### components.RsHeader.props.headerSize.name[​](#componentsrsheaderpropsheadersizename "Direct link to components.RsHeader.props.headerSize.name")

> **components.RsHeader.props.headerSize.name**: `string` = `"Header size"`

#### components.RsImage[​](#componentsrsimage "Direct link to components.RsImage")

> **components.RsImage**: `object`

#### components.RsImage.description[​](#componentsrsimagedescription "Direct link to components.RsImage.description")

> **components.RsImage.description**: `string` = `"Simple HTML image"`

#### components.RsImage.name[​](#componentsrsimagename "Direct link to components.RsImage.name")

> **components.RsImage.name**: `string` = `"Image"`

#### components.RsImage.props[​](#componentsrsimageprops "Direct link to components.RsImage.props")

> **components.RsImage.props**: `object`

#### components.RsImage.props.alt[​](#componentsrsimagepropsalt "Direct link to components.RsImage.props.alt")

> **components.RsImage.props.alt**: `object`

#### components.RsImage.props.alt.description[​](#componentsrsimagepropsaltdescription "Direct link to components.RsImage.props.alt.description")

> **components.RsImage.props.alt.description**: `string` = `"Image description"`

#### components.RsImage.props.alt.name[​](#componentsrsimagepropsaltname "Direct link to components.RsImage.props.alt.name")

> **components.RsImage.props.alt.name**: `string` = `"Description"`

#### components.RsImage.props.src[​](#componentsrsimagepropssrc "Direct link to components.RsImage.props.src")

> **components.RsImage.props.src**: `object`

#### components.RsImage.props.src.description[​](#componentsrsimagepropssrcdescription "Direct link to components.RsImage.props.src.description")

> **components.RsImage.props.src.description**: `string` = `"Image source"`

#### components.RsImage.props.src.name[​](#componentsrsimagepropssrcname "Direct link to components.RsImage.props.src.name")

> **components.RsImage.props.src.name**: `string` = `"Src"`

#### components.RsInput[​](#componentsrsinput "Direct link to components.RsInput")

> **components.RsInput**: `object`

#### components.RsInput.description[​](#componentsrsinputdescription "Direct link to components.RsInput.description")

> **components.RsInput.description**: `string` = `"Input let users enter and edit text"`

#### components.RsInput.name[​](#componentsrsinputname "Direct link to components.RsInput.name")

> **components.RsInput.name**: `string` = `"Input"`

#### components.RsInput.props[​](#componentsrsinputprops "Direct link to components.RsInput.props")

> **components.RsInput.props**: `object`

#### components.RsInput.props.passwordMask[​](#componentsrsinputpropspasswordmask "Direct link to components.RsInput.props.passwordMask")

> **components.RsInput.props.passwordMask**: `object`

#### components.RsInput.props.passwordMask.description[​](#componentsrsinputpropspasswordmaskdescription "Direct link to components.RsInput.props.passwordMask.description")

> **components.RsInput.props.passwordMask.description**: `string` = `"Use password mask"`

#### components.RsInput.props.passwordMask.name[​](#componentsrsinputpropspasswordmaskname "Direct link to components.RsInput.props.passwordMask.name")

> **components.RsInput.props.passwordMask.name**: `string` = `"Password mask"`

#### components.RsInput.props.showPasswordAriaLabel[​](#componentsrsinputpropsshowpasswordarialabel "Direct link to components.RsInput.props.showPasswordAriaLabel")

> **components.RsInput.props.showPasswordAriaLabel**: `object`

#### components.RsInput.props.showPasswordAriaLabel.description[​](#componentsrsinputpropsshowpasswordarialabeldescription "Direct link to components.RsInput.props.showPasswordAriaLabel.description")

> **components.RsInput.props.showPasswordAriaLabel.description**: `string` = `"Value of the aria-label attribute for the show password button when the input is in password mask mode"`

#### components.RsInput.props.showPasswordAriaLabel.name[​](#componentsrsinputpropsshowpasswordarialabelname "Direct link to components.RsInput.props.showPasswordAriaLabel.name")

> **components.RsInput.props.showPasswordAriaLabel.name**: `string` = `"ARIA label for show password button"`

#### components.RsInput.props.type[​](#componentsrsinputpropstype "Direct link to components.RsInput.props.type")

> **components.RsInput.props.type**: `object`

#### components.RsInput.props.type.description[​](#componentsrsinputpropstypedescription "Direct link to components.RsInput.props.type.description")

> **components.RsInput.props.type.description**: `string` = `"HTML input type"`

#### components.RsInput.props.type.name[​](#componentsrsinputpropstypename "Direct link to components.RsInput.props.type.name")

> **components.RsInput.props.type.name**: `string` = `"Type"`

#### components.RsLabel[​](#componentsrslabel "Direct link to components.RsLabel")

> **components.RsLabel**: `object`

#### components.RsLabel.description[​](#componentsrslabeldescription "Direct link to components.RsLabel.description")

> **components.RsLabel.description**: `string` = `"Simple HTML label"`

#### components.RsLabel.name[​](#componentsrslabelname "Direct link to components.RsLabel.name")

> **components.RsLabel.name**: `string` = `"Label"`

#### components.RsLabel.props[​](#componentsrslabelprops "Direct link to components.RsLabel.props")

> **components.RsLabel.props**: `object`

#### components.RsLabel.props.text[​](#componentsrslabelpropstext "Direct link to components.RsLabel.props.text")

> **components.RsLabel.props.text**: `object`

#### components.RsLabel.props.text.description[​](#componentsrslabelpropstextdescription "Direct link to components.RsLabel.props.text.description")

> **components.RsLabel.props.text.description**: `string` = `"The label text content"`

#### components.RsLabel.props.text.name[​](#componentsrslabelpropstextname "Direct link to components.RsLabel.props.text.name")

> **components.RsLabel.props.text.name**: `string` = `"Text"`

#### components.RsLink[​](#componentsrslink "Direct link to components.RsLink")

> **components.RsLink**: `object`

#### components.RsLink.description[​](#componentsrslinkdescription "Direct link to components.RsLink.description")

> **components.RsLink.description**: `string` = `"Simple HTML anchor"`

#### components.RsLink.name[​](#componentsrslinkname "Direct link to components.RsLink.name")

> **components.RsLink.name**: `string` = `"Link"`

#### components.RsLink.props[​](#componentsrslinkprops "Direct link to components.RsLink.props")

> **components.RsLink.props**: `object`

#### components.RsLink.props.children[​](#componentsrslinkpropschildren "Direct link to components.RsLink.props.children")

> **components.RsLink.props.children**: `object`

#### components.RsLink.props.children.description[​](#componentsrslinkpropschildrendescription "Direct link to components.RsLink.props.children.description")

> **components.RsLink.props.children.description**: `string` = `"Component children"`

#### components.RsLink.props.children.name[​](#componentsrslinkpropschildrenname "Direct link to components.RsLink.props.children.name")

> **components.RsLink.props.children.name**: `string` = `"Children"`

#### components.RsLink.props.content[​](#componentsrslinkpropscontent "Direct link to components.RsLink.props.content")

> **components.RsLink.props.content**: `object`

#### components.RsLink.props.content.description[​](#componentsrslinkpropscontentdescription "Direct link to components.RsLink.props.content.description")

> **components.RsLink.props.content.description**: `string` = `"The content type (text or custom)"`

#### components.RsLink.props.content.name[​](#componentsrslinkpropscontentname "Direct link to components.RsLink.props.content.name")

> **components.RsLink.props.content.name**: `string` = `"Content"`

#### components.RsLink.props.download[​](#componentsrslinkpropsdownload "Direct link to components.RsLink.props.download")

> **components.RsLink.props.download**: `object`

#### components.RsLink.props.download.description[​](#componentsrslinkpropsdownloaddescription "Direct link to components.RsLink.props.download.description")

> **components.RsLink.props.download.description**: `string` = `"Causes the browser to treat the linked URL as a download"`

#### components.RsLink.props.download.name[​](#componentsrslinkpropsdownloadname "Direct link to components.RsLink.props.download.name")

> **components.RsLink.props.download.name**: `string` = `"Download"`

#### components.RsLink.props.downloadFilename[​](#componentsrslinkpropsdownloadfilename "Direct link to components.RsLink.props.downloadFilename")

> **components.RsLink.props.downloadFilename**: `object`

#### components.RsLink.props.downloadFilename.description[​](#componentsrslinkpropsdownloadfilenamedescription "Direct link to components.RsLink.props.downloadFilename.description")

> **components.RsLink.props.downloadFilename.description**: `string` = `"Defining a value suggests it as the filename. / and \\ characters are converted to underscores (_)"`

#### components.RsLink.props.downloadFilename.name[​](#componentsrslinkpropsdownloadfilenamename "Direct link to components.RsLink.props.downloadFilename.name")

> **components.RsLink.props.downloadFilename.name**: `string` = `"Download filename"`

#### components.RsLink.props.href[​](#componentsrslinkpropshref "Direct link to components.RsLink.props.href")

> **components.RsLink.props.href**: `object`

#### components.RsLink.props.href.description[​](#componentsrslinkpropshrefdescription "Direct link to components.RsLink.props.href.description")

> **components.RsLink.props.href.description**: `string` = `"The URL that the hyperlink points to"`

#### components.RsLink.props.href.name[​](#componentsrslinkpropshrefname "Direct link to components.RsLink.props.href.name")

> **components.RsLink.props.href.name**: `string` = `"Href"`

#### components.RsLink.props.onClick[​](#componentsrslinkpropsonclick "Direct link to components.RsLink.props.onClick")

> **components.RsLink.props.onClick**: `object`

#### components.RsLink.props.onClick.description[​](#componentsrslinkpropsonclickdescription "Direct link to components.RsLink.props.onClick.description")

> **components.RsLink.props.onClick.description**: `string` = `"Callback function when a link is clicked"`

#### components.RsLink.props.onClick.name[​](#componentsrslinkpropsonclickname "Direct link to components.RsLink.props.onClick.name")

> **components.RsLink.props.onClick.name**: `string` = `"onClick"`

#### components.RsLink.props.target[​](#componentsrslinkpropstarget "Direct link to components.RsLink.props.target")

> **components.RsLink.props.target**: `object`

#### components.RsLink.props.target.description[​](#componentsrslinkpropstargetdescription "Direct link to components.RsLink.props.target.description")

> **components.RsLink.props.target.description**: `string` = `"Where to display the linked URL, as the name for a browsing context (a tab, window, or <iframe>)"`

#### components.RsLink.props.target.name[​](#componentsrslinkpropstargetname "Direct link to components.RsLink.props.target.name")

> **components.RsLink.props.target.name**: `string` = `"Target"`

#### components.RsLink.props.text[​](#componentsrslinkpropstext "Direct link to components.RsLink.props.text")

> **components.RsLink.props.text**: `object`

#### components.RsLink.props.text.description[​](#componentsrslinkpropstextdescription "Direct link to components.RsLink.props.text.description")

> **components.RsLink.props.text.description**: `string` = `"The link text content"`

#### components.RsLink.props.text.name[​](#componentsrslinkpropstextname "Direct link to components.RsLink.props.text.name")

> **components.RsLink.props.text.name**: `string` = `"Text"`

#### components.RsMenu[​](#componentsrsmenu "Direct link to components.RsMenu")

> **components.RsMenu**: `object`

#### components.RsMenu.description[​](#componentsrsmenudescription "Direct link to components.RsMenu.description")

> **components.RsMenu.description**: `string` = `"Provides a list of various forms of navigation menus, which can be landscape and portrait layout"`

#### components.RsMenu.name[​](#componentsrsmenuname "Direct link to components.RsMenu.name")

> **components.RsMenu.name**: `string` = `"Menu"`

#### components.RsMenu.props[​](#componentsrsmenuprops "Direct link to components.RsMenu.props")

> **components.RsMenu.props**: `object`

#### components.RsMenu.props.activeKey[​](#componentsrsmenupropsactivekey "Direct link to components.RsMenu.props.activeKey")

> **components.RsMenu.props.activeKey**: `object`

#### components.RsMenu.props.activeKey.description[​](#componentsrsmenupropsactivekeydescription "Direct link to components.RsMenu.props.activeKey.description")

> **components.RsMenu.props.activeKey.description**: `string` = `"Active key, corresponding to one of items value"`

#### components.RsMenu.props.activeKey.name[​](#componentsrsmenupropsactivekeyname "Direct link to components.RsMenu.props.activeKey.name")

> **components.RsMenu.props.activeKey.name**: `string` = `"Active key"`

#### components.RsMenu.props.appearance[​](#componentsrsmenupropsappearance "Direct link to components.RsMenu.props.appearance")

> **components.RsMenu.props.appearance**: `object`

#### components.RsMenu.props.appearance.description[​](#componentsrsmenupropsappearancedescription "Direct link to components.RsMenu.props.appearance.description")

> **components.RsMenu.props.appearance.description**: `string` = `"A navigation can have different appearances"`

#### components.RsMenu.props.appearance.name[​](#componentsrsmenupropsappearancename "Direct link to components.RsMenu.props.appearance.name")

> **components.RsMenu.props.appearance.name**: `string` = `"Appearance"`

#### components.RsMenu.props.items[​](#componentsrsmenupropsitems "Direct link to components.RsMenu.props.items")

> **components.RsMenu.props.items**: `object`

#### components.RsMenu.props.items.description[​](#componentsrsmenupropsitemsdescription "Direct link to components.RsMenu.props.items.description")

> **components.RsMenu.props.items.description**: `string` = `"The items for the menu"`

#### components.RsMenu.props.items.name[​](#componentsrsmenupropsitemsname "Direct link to components.RsMenu.props.items.name")

> **components.RsMenu.props.items.name**: `string` = `"Items"`

#### components.RsMenu.props.itemsAs[​](#componentsrsmenupropsitemsas "Direct link to components.RsMenu.props.itemsAs")

> **components.RsMenu.props.itemsAs**: `object`

#### components.RsMenu.props.itemsAs.description[​](#componentsrsmenupropsitemsasdescription "Direct link to components.RsMenu.props.itemsAs.description")

> **components.RsMenu.props.itemsAs.description**: `string` = `"HTML element to render menu item"`

#### components.RsMenu.props.itemsAs.name[​](#componentsrsmenupropsitemsasname "Direct link to components.RsMenu.props.itemsAs.name")

> **components.RsMenu.props.itemsAs.name**: `string` = `"Items As"`

#### components.RsMenu.props.justified[​](#componentsrsmenupropsjustified "Direct link to components.RsMenu.props.justified")

> **components.RsMenu.props.justified**: `object`

#### components.RsMenu.props.justified.description[​](#componentsrsmenupropsjustifieddescription "Direct link to components.RsMenu.props.justified.description")

> **components.RsMenu.props.justified.description**: `string` = `"Justified navigation"`

#### components.RsMenu.props.justified.name[​](#componentsrsmenupropsjustifiedname "Direct link to components.RsMenu.props.justified.name")

> **components.RsMenu.props.justified.name**: `string` = `"Justified"`

#### components.RsMenu.props.onSelect[​](#componentsrsmenupropsonselect "Direct link to components.RsMenu.props.onSelect")

> **components.RsMenu.props.onSelect**: `object`

#### components.RsMenu.props.onSelect.description[​](#componentsrsmenupropsonselectdescription "Direct link to components.RsMenu.props.onSelect.description")

> **components.RsMenu.props.onSelect.description**: `string` = `"Callback function triggered after selection"`

#### components.RsMenu.props.onSelect.name[​](#componentsrsmenupropsonselectname "Direct link to components.RsMenu.props.onSelect.name")

> **components.RsMenu.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsMenu.props.reversed[​](#componentsrsmenupropsreversed "Direct link to components.RsMenu.props.reversed")

> **components.RsMenu.props.reversed**: `object`

#### components.RsMenu.props.reversed.description[​](#componentsrsmenupropsreverseddescription "Direct link to components.RsMenu.props.reversed.description")

> **components.RsMenu.props.reversed.description**: `string` = `"Reverse direction of tabs/subtle"`

#### components.RsMenu.props.reversed.name[​](#componentsrsmenupropsreversedname "Direct link to components.RsMenu.props.reversed.name")

> **components.RsMenu.props.reversed.name**: `string` = `"Reversed"`

#### components.RsMenu.props.vertical[​](#componentsrsmenupropsvertical "Direct link to components.RsMenu.props.vertical")

> **components.RsMenu.props.vertical**: `object`

#### components.RsMenu.props.vertical.description[​](#componentsrsmenupropsverticaldescription "Direct link to components.RsMenu.props.vertical.description")

> **components.RsMenu.props.vertical.description**: `string` = `"Stacked navigation"`

#### components.RsMenu.props.vertical.name[​](#componentsrsmenupropsverticalname "Direct link to components.RsMenu.props.vertical.name")

> **components.RsMenu.props.vertical.name**: `string` = `"Vertical"`

#### components.RsMessage[​](#componentsrsmessage "Direct link to components.RsMessage")

> **components.RsMessage**: `object`

#### components.RsMessage.description[​](#componentsrsmessagedescription "Direct link to components.RsMessage.description")

> **components.RsMessage.description**: `string` = `"Used to show important tips on a page"`

#### components.RsMessage.name[​](#componentsrsmessagename "Direct link to components.RsMessage.name")

> **components.RsMessage.name**: `string` = `"Message"`

#### components.RsMessage.props[​](#componentsrsmessageprops "Direct link to components.RsMessage.props")

> **components.RsMessage.props**: `object`

#### components.RsMessage.props.closable[​](#componentsrsmessagepropsclosable "Direct link to components.RsMessage.props.closable")

> **components.RsMessage.props.closable**: `object`

#### components.RsMessage.props.closable.description[​](#componentsrsmessagepropsclosabledescription "Direct link to components.RsMessage.props.closable.description")

> **components.RsMessage.props.closable.description**: `string` = `"Whether it is possible to close the message box"`

#### components.RsMessage.props.closable.name[​](#componentsrsmessagepropsclosablename "Direct link to components.RsMessage.props.closable.name")

> **components.RsMessage.props.closable.name**: `string` = `"Closable"`

#### components.RsMessage.props.header[​](#componentsrsmessagepropsheader "Direct link to components.RsMessage.props.header")

> **components.RsMessage.props.header**: `object`

#### components.RsMessage.props.header.description[​](#componentsrsmessagepropsheaderdescription "Direct link to components.RsMessage.props.header.description")

> **components.RsMessage.props.header.description**: `string` = `"The title of the message"`

#### components.RsMessage.props.header.name[​](#componentsrsmessagepropsheadername "Direct link to components.RsMessage.props.header.name")

> **components.RsMessage.props.header.name**: `string` = `"Header"`

#### components.RsMessage.props.type[​](#componentsrsmessagepropstype "Direct link to components.RsMessage.props.type")

> **components.RsMessage.props.type**: `object`

#### components.RsMessage.props.type.description[​](#componentsrsmessagepropstypedescription "Direct link to components.RsMessage.props.type.description")

> **components.RsMessage.props.type.description**: `string` = `"The type of the message box"`

#### components.RsMessage.props.type.name[​](#componentsrsmessagepropstypename "Direct link to components.RsMessage.props.type.name")

> **components.RsMessage.props.type.name**: `string` = `"Type"`

#### components.RsModal[​](#componentsrsmodal "Direct link to components.RsModal")

> **components.RsModal**: `object`

#### components.RsModal.description[​](#componentsrsmodaldescription "Direct link to components.RsModal.description")

> **components.RsModal.description**: `string` = `"A modal dialog box component for message prompts, acknowledgement messages, and submissions"`

#### components.RsModal.name[​](#componentsrsmodalname "Direct link to components.RsModal.name")

> **components.RsModal.name**: `string` = `"Modal"`

#### components.RsModal.props[​](#componentsrsmodalprops "Direct link to components.RsModal.props")

> **components.RsModal.props**: `object`

#### components.RsModal.props.autoFocus[​](#componentsrsmodalpropsautofocus "Direct link to components.RsModal.props.autoFocus")

> **components.RsModal.props.autoFocus**: `object`

#### components.RsModal.props.autoFocus.description[​](#componentsrsmodalpropsautofocusdescription "Direct link to components.RsModal.props.autoFocus.description")

> **components.RsModal.props.autoFocus.description**: `string` = `"When set to true, the Modal is opened and is automatically focused on its own, accessible to screen readers"`

#### components.RsModal.props.autoFocus.name[​](#componentsrsmodalpropsautofocusname "Direct link to components.RsModal.props.autoFocus.name")

> **components.RsModal.props.autoFocus.name**: `string` = `"Auto focus"`

#### components.RsModal.props.backdrop[​](#componentsrsmodalpropsbackdrop "Direct link to components.RsModal.props.backdrop")

> **components.RsModal.props.backdrop**: `object`

#### components.RsModal.props.backdrop.description[​](#componentsrsmodalpropsbackdropdescription "Direct link to components.RsModal.props.backdrop.description")

> **components.RsModal.props.backdrop.description**: `string` = `"When set to true, the Modal will display the background when it is opened. Clicking on the background will close the Modal"`

#### components.RsModal.props.backdrop.name[​](#componentsrsmodalpropsbackdropname "Direct link to components.RsModal.props.backdrop.name")

> **components.RsModal.props.backdrop.name**: `string` = `"Backdrop"`

#### components.RsModal.props.backdropClassName[​](#componentsrsmodalpropsbackdropclassname "Direct link to components.RsModal.props.backdropClassName")

> **components.RsModal.props.backdropClassName**: `object`

#### components.RsModal.props.backdropClassName.description[​](#componentsrsmodalpropsbackdropclassnamedescription "Direct link to components.RsModal.props.backdropClassName.description")

> **components.RsModal.props.backdropClassName.description**: `string` = `"Add an optional extra class name to .modal-backdrop It could end up looking like class=\"modal-backdrop foo-modal-backdrop in\""`

#### components.RsModal.props.backdropClassName.name[​](#componentsrsmodalpropsbackdropclassnamename "Direct link to components.RsModal.props.backdropClassName.name")

> **components.RsModal.props.backdropClassName.name**: `string` = `"Backdrop className"`

#### components.RsModal.props.classPrefix[​](#componentsrsmodalpropsclassprefix "Direct link to components.RsModal.props.classPrefix")

> **components.RsModal.props.classPrefix**: `object`

#### components.RsModal.props.classPrefix.description[​](#componentsrsmodalpropsclassprefixdescription "Direct link to components.RsModal.props.classPrefix.description")

> **components.RsModal.props.classPrefix.description**: `string` = `"The prefix of the component CSS class"`

#### components.RsModal.props.classPrefix.name[​](#componentsrsmodalpropsclassprefixname "Direct link to components.RsModal.props.classPrefix.name")

> **components.RsModal.props.classPrefix.name**: `string` = `"CSS class prefix"`

#### components.RsModal.props.dialogClassName[​](#componentsrsmodalpropsdialogclassname "Direct link to components.RsModal.props.dialogClassName")

> **components.RsModal.props.dialogClassName**: `object`

#### components.RsModal.props.dialogClassName.description[​](#componentsrsmodalpropsdialogclassnamedescription "Direct link to components.RsModal.props.dialogClassName.description")

> **components.RsModal.props.dialogClassName.description**: `string` = `"CSS class applied to Dialog DOM nodes"`

#### components.RsModal.props.dialogClassName.name[​](#componentsrsmodalpropsdialogclassnamename "Direct link to components.RsModal.props.dialogClassName.name")

> **components.RsModal.props.dialogClassName.name**: `string` = `"CSS class for dialog"`

#### components.RsModal.props.enforceFocus[​](#componentsrsmodalpropsenforcefocus "Direct link to components.RsModal.props.enforceFocus")

> **components.RsModal.props.enforceFocus**: `object`

#### components.RsModal.props.enforceFocus.description[​](#componentsrsmodalpropsenforcefocusdescription "Direct link to components.RsModal.props.enforceFocus.description")

> **components.RsModal.props.enforceFocus.description**: `string` = `"When set to true, Modal will prevent the focus from leaving when opened, making it easier for the secondary screen reader to access"`

#### components.RsModal.props.enforceFocus.name[​](#componentsrsmodalpropsenforcefocusname "Direct link to components.RsModal.props.enforceFocus.name")

> **components.RsModal.props.enforceFocus.name**: `string` = `"Enforce focus"`

#### components.RsModal.props.keyboard[​](#componentsrsmodalpropskeyboard "Direct link to components.RsModal.props.keyboard")

> **components.RsModal.props.keyboard**: `object`

#### components.RsModal.props.keyboard.description[​](#componentsrsmodalpropskeyboarddescription "Direct link to components.RsModal.props.keyboard.description")

> **components.RsModal.props.keyboard.description**: `string` = `"Close Modal when Esc key is pressed"`

#### components.RsModal.props.keyboard.name[​](#componentsrsmodalpropskeyboardname "Direct link to components.RsModal.props.keyboard.name")

> **components.RsModal.props.keyboard.name**: `string` = `"Close by Esc"`

#### components.RsModal.props.onClose[​](#componentsrsmodalpropsonclose "Direct link to components.RsModal.props.onClose")

> **components.RsModal.props.onClose**: `object`

#### components.RsModal.props.onClose.description[​](#componentsrsmodalpropsonclosedescription "Direct link to components.RsModal.props.onClose.description")

> **components.RsModal.props.onClose.description**: `string` = `"Called when Modal is closed"`

#### components.RsModal.props.onClose.name[​](#componentsrsmodalpropsonclosename "Direct link to components.RsModal.props.onClose.name")

> **components.RsModal.props.onClose.name**: `string` = `"onClose"`

#### components.RsModal.props.onOpen[​](#componentsrsmodalpropsonopen "Direct link to components.RsModal.props.onOpen")

> **components.RsModal.props.onOpen**: `object`

#### components.RsModal.props.onOpen.description[​](#componentsrsmodalpropsonopendescription "Direct link to components.RsModal.props.onOpen.description")

> **components.RsModal.props.onOpen.description**: `string` = `"Called when Modal is displayed"`

#### components.RsModal.props.onOpen.name[​](#componentsrsmodalpropsonopenname "Direct link to components.RsModal.props.onOpen.name")

> **components.RsModal.props.onOpen.name**: `string` = `"onOpen"`

#### components.RsModal.props.overflow[​](#componentsrsmodalpropsoverflow "Direct link to components.RsModal.props.overflow")

> **components.RsModal.props.overflow**: `object`

#### components.RsModal.props.overflow\.description[​](#componentsrsmodalpropsoverflowdescription "Direct link to components.RsModal.props.overflow.description")

> **components.RsModal.props.overflow\.description**: `string` = `"Automatically sets the height when the body content is too long"`

#### components.RsModal.props.overflow\.name[​](#componentsrsmodalpropsoverflowname "Direct link to components.RsModal.props.overflow.name")

> **components.RsModal.props.overflow\.name**: `string` = `"Overflow"`

#### components.RsModal.props.size[​](#componentsrsmodalpropssize "Direct link to components.RsModal.props.size")

> **components.RsModal.props.size**: `object`

#### components.RsModal.props.size.description[​](#componentsrsmodalpropssizedescription "Direct link to components.RsModal.props.size.description")

> **components.RsModal.props.size.description**: `string` = `"Determine the width of the modal"`

#### components.RsModal.props.size.name[​](#componentsrsmodalpropssizename "Direct link to components.RsModal.props.size.name")

> **components.RsModal.props.size.name**: `string` = `"Size"`

#### components.RsModalLayout[​](#componentsrsmodallayout "Direct link to components.RsModalLayout")

> **components.RsModalLayout**: `object`

#### components.RsModalLayout.description[​](#componentsrsmodallayoutdescription "Direct link to components.RsModalLayout.description")

> **components.RsModalLayout.description**: `string` = `"Modal layout component with header, body and footer sections"`

#### components.RsModalLayout.name[​](#componentsrsmodallayoutname "Direct link to components.RsModalLayout.name")

> **components.RsModalLayout.name**: `string` = `"Modal layout"`

#### components.RsModalLayout.props[​](#componentsrsmodallayoutprops "Direct link to components.RsModalLayout.props")

> **components.RsModalLayout.props**: `object`

#### components.RsModalLayout.props.body[​](#componentsrsmodallayoutpropsbody "Direct link to components.RsModalLayout.props.body")

> **components.RsModalLayout.props.body**: `object`

#### components.RsModalLayout.props.body.description[​](#componentsrsmodallayoutpropsbodydescription "Direct link to components.RsModalLayout.props.body.description")

> **components.RsModalLayout.props.body.description**: `string` = `"The content for the modal body"`

#### components.RsModalLayout.props.body.name[​](#componentsrsmodallayoutpropsbodyname "Direct link to components.RsModalLayout.props.body.name")

> **components.RsModalLayout.props.body.name**: `string` = `"Body"`

#### components.RsModalLayout.props.closeButton[​](#componentsrsmodallayoutpropsclosebutton "Direct link to components.RsModalLayout.props.closeButton")

> **components.RsModalLayout.props.closeButton**: `object`

#### components.RsModalLayout.props.closeButton.description[​](#componentsrsmodallayoutpropsclosebuttondescription "Direct link to components.RsModalLayout.props.closeButton.description")

> **components.RsModalLayout.props.closeButton.description**: `string` = `"Display close button"`

#### components.RsModalLayout.props.closeButton.name[​](#componentsrsmodallayoutpropsclosebuttonname "Direct link to components.RsModalLayout.props.closeButton.name")

> **components.RsModalLayout.props.closeButton.name**: `string` = `"Close button"`

#### components.RsModalLayout.props.footer[​](#componentsrsmodallayoutpropsfooter "Direct link to components.RsModalLayout.props.footer")

> **components.RsModalLayout.props.footer**: `object`

#### components.RsModalLayout.props.footer.description[​](#componentsrsmodallayoutpropsfooterdescription "Direct link to components.RsModalLayout.props.footer.description")

> **components.RsModalLayout.props.footer.description**: `string` = `"The content for the modal footer"`

#### components.RsModalLayout.props.footer.name[​](#componentsrsmodallayoutpropsfootername "Direct link to components.RsModalLayout.props.footer.name")

> **components.RsModalLayout.props.footer.name**: `string` = `"Footer"`

#### components.RsModalLayout.props.headerTitle[​](#componentsrsmodallayoutpropsheadertitle "Direct link to components.RsModalLayout.props.headerTitle")

> **components.RsModalLayout.props.headerTitle**: `object`

#### components.RsModalLayout.props.headerTitle.description[​](#componentsrsmodallayoutpropsheadertitledescription "Direct link to components.RsModalLayout.props.headerTitle.description")

> **components.RsModalLayout.props.headerTitle.description**: `string` = `"The title for the modal header"`

#### components.RsModalLayout.props.headerTitle.name[​](#componentsrsmodallayoutpropsheadertitlename "Direct link to components.RsModalLayout.props.headerTitle.name")

> **components.RsModalLayout.props.headerTitle.name**: `string` = `"Header title"`

#### components.RsNumberFormat[​](#componentsrsnumberformat "Direct link to components.RsNumberFormat")

> **components.RsNumberFormat**: `object`

#### components.RsNumberFormat.description[​](#componentsrsnumberformatdescription "Direct link to components.RsNumberFormat.description")

> **components.RsNumberFormat.description**: `string` = `"A number format input component with validation and formatting"`

#### components.RsNumberFormat.name[​](#componentsrsnumberformatname "Direct link to components.RsNumberFormat.name")

> **components.RsNumberFormat.name**: `string` = `"Number format"`

#### components.RsNumberFormat.props[​](#componentsrsnumberformatprops "Direct link to components.RsNumberFormat.props")

> **components.RsNumberFormat.props**: `object`

#### components.RsNumberFormat.props.allowedDecimalSeparators[​](#componentsrsnumberformatpropsalloweddecimalseparators "Direct link to components.RsNumberFormat.props.allowedDecimalSeparators")

> **components.RsNumberFormat.props.allowedDecimalSeparators**: `object`

#### components.RsNumberFormat.props.allowedDecimalSeparators.description[​](#componentsrsnumberformatpropsalloweddecimalseparatorsdescription "Direct link to components.RsNumberFormat.props.allowedDecimalSeparators.description")

> **components.RsNumberFormat.props.allowedDecimalSeparators.description**: `string` = `"Characters which when pressed result in a decimal separator. When missing, decimal separator and '.' are used"`

#### components.RsNumberFormat.props.allowedDecimalSeparators.name[​](#componentsrsnumberformatpropsalloweddecimalseparatorsname "Direct link to components.RsNumberFormat.props.allowedDecimalSeparators.name")

> **components.RsNumberFormat.props.allowedDecimalSeparators.name**: `string` = `"Allowed decimal separators"`

#### components.RsNumberFormat.props.allowLeadingZeros[​](#componentsrsnumberformatpropsallowleadingzeros "Direct link to components.RsNumberFormat.props.allowLeadingZeros")

> **components.RsNumberFormat.props.allowLeadingZeros**: `object`

#### components.RsNumberFormat.props.allowLeadingZeros.description[​](#componentsrsnumberformatpropsallowleadingzerosdescription "Direct link to components.RsNumberFormat.props.allowLeadingZeros.description")

> **components.RsNumberFormat.props.allowLeadingZeros.description**: `string` = `"This allows enabling or disabling leading zeros in the input field. By default, on blur of an input, leading zeros are removed"`

#### components.RsNumberFormat.props.allowLeadingZeros.name[​](#componentsrsnumberformatpropsallowleadingzerosname "Direct link to components.RsNumberFormat.props.allowLeadingZeros.name")

> **components.RsNumberFormat.props.allowLeadingZeros.name**: `string` = `"Allow leading zeros"`

#### components.RsNumberFormat.props.allowNegative[​](#componentsrsnumberformatpropsallownegative "Direct link to components.RsNumberFormat.props.allowNegative")

> **components.RsNumberFormat.props.allowNegative**: `object`

#### components.RsNumberFormat.props.allowNegative.description[​](#componentsrsnumberformatpropsallownegativedescription "Direct link to components.RsNumberFormat.props.allowNegative.description")

> **components.RsNumberFormat.props.allowNegative.description**: `string` = `"If set to false, negative numbers will not be allowed"`

#### components.RsNumberFormat.props.allowNegative.name[​](#componentsrsnumberformatpropsallownegativename "Direct link to components.RsNumberFormat.props.allowNegative.name")

> **components.RsNumberFormat.props.allowNegative.name**: `string` = `"Allow negative"`

#### components.RsNumberFormat.props.decimalScale[​](#componentsrsnumberformatpropsdecimalscale "Direct link to components.RsNumberFormat.props.decimalScale")

> **components.RsNumberFormat.props.decimalScale**: `object`

#### components.RsNumberFormat.props.decimalScale.description[​](#componentsrsnumberformatpropsdecimalscaledescription "Direct link to components.RsNumberFormat.props.decimalScale.description")

> **components.RsNumberFormat.props.decimalScale.description**: `string` = `"If defined, it limits the number of digits after the decimal point"`

#### components.RsNumberFormat.props.decimalScale.name[​](#componentsrsnumberformatpropsdecimalscalename "Direct link to components.RsNumberFormat.props.decimalScale.name")

> **components.RsNumberFormat.props.decimalScale.name**: `string` = `"Decimal scale"`

#### components.RsNumberFormat.props.decimalSeparator[​](#componentsrsnumberformatpropsdecimalseparator "Direct link to components.RsNumberFormat.props.decimalSeparator")

> **components.RsNumberFormat.props.decimalSeparator**: `object`

#### components.RsNumberFormat.props.decimalSeparator.description[​](#componentsrsnumberformatpropsdecimalseparatordescription "Direct link to components.RsNumberFormat.props.decimalSeparator.description")

> **components.RsNumberFormat.props.decimalSeparator.description**: `string` = `"Defines the decimal character"`

#### components.RsNumberFormat.props.decimalSeparator.name[​](#componentsrsnumberformatpropsdecimalseparatorname "Direct link to components.RsNumberFormat.props.decimalSeparator.name")

> **components.RsNumberFormat.props.decimalSeparator.name**: `string` = `"Decimal separator"`

#### components.RsNumberFormat.props.fixedDecimalScale[​](#componentsrsnumberformatpropsfixeddecimalscale "Direct link to components.RsNumberFormat.props.fixedDecimalScale")

> **components.RsNumberFormat.props.fixedDecimalScale**: `object`

#### components.RsNumberFormat.props.fixedDecimalScale.description[​](#componentsrsnumberformatpropsfixeddecimalscaledescription "Direct link to components.RsNumberFormat.props.fixedDecimalScale.description")

> **components.RsNumberFormat.props.fixedDecimalScale.description**: `string` = `"If set to true, it adds trailing 0s after decimalSeparator to match given decimalScale"`

#### components.RsNumberFormat.props.fixedDecimalScale.name[​](#componentsrsnumberformatpropsfixeddecimalscalename "Direct link to components.RsNumberFormat.props.fixedDecimalScale.name")

> **components.RsNumberFormat.props.fixedDecimalScale.name**: `string` = `"Fixed decimal scale"`

#### components.RsNumberFormat.props.prefix[​](#componentsrsnumberformatpropsprefix "Direct link to components.RsNumberFormat.props.prefix")

> **components.RsNumberFormat.props.prefix**: `object`

#### components.RsNumberFormat.props.prefix.description[​](#componentsrsnumberformatpropsprefixdescription "Direct link to components.RsNumberFormat.props.prefix.description")

> **components.RsNumberFormat.props.prefix.description**: `string` = `"Adds the prefix character before the input value"`

#### components.RsNumberFormat.props.prefix.name[​](#componentsrsnumberformatpropsprefixname "Direct link to components.RsNumberFormat.props.prefix.name")

> **components.RsNumberFormat.props.prefix.name**: `string` = `"Prefix"`

#### components.RsNumberFormat.props.suffix[​](#componentsrsnumberformatpropssuffix "Direct link to components.RsNumberFormat.props.suffix")

> **components.RsNumberFormat.props.suffix**: `object`

#### components.RsNumberFormat.props.suffix.description[​](#componentsrsnumberformatpropssuffixdescription "Direct link to components.RsNumberFormat.props.suffix.description")

> **components.RsNumberFormat.props.suffix.description**: `string` = `"Adds the suffix after the input value"`

#### components.RsNumberFormat.props.suffix.name[​](#componentsrsnumberformatpropssuffixname "Direct link to components.RsNumberFormat.props.suffix.name")

> **components.RsNumberFormat.props.suffix.name**: `string` = `"Suffix"`

#### components.RsNumberFormat.props.thousandSeparator[​](#componentsrsnumberformatpropsthousandseparator "Direct link to components.RsNumberFormat.props.thousandSeparator")

> **components.RsNumberFormat.props.thousandSeparator**: `object`

#### components.RsNumberFormat.props.thousandSeparator.description[​](#componentsrsnumberformatpropsthousandseparatordescription "Direct link to components.RsNumberFormat.props.thousandSeparator.description")

> **components.RsNumberFormat.props.thousandSeparator.description**: `string` = `"Thousand separator"`

#### components.RsNumberFormat.props.thousandSeparator.name[​](#componentsrsnumberformatpropsthousandseparatorname "Direct link to components.RsNumberFormat.props.thousandSeparator.name")

> **components.RsNumberFormat.props.thousandSeparator.name**: `string` = `"Thousand separator"`

#### components.RsNumberFormat.props.thousandsGroupStyle[​](#componentsrsnumberformatpropsthousandsgroupstyle "Direct link to components.RsNumberFormat.props.thousandsGroupStyle")

> **components.RsNumberFormat.props.thousandsGroupStyle**: `object`

#### components.RsNumberFormat.props.thousandsGroupStyle.description[​](#componentsrsnumberformatpropsthousandsgroupstyledescription "Direct link to components.RsNumberFormat.props.thousandsGroupStyle.description")

> **components.RsNumberFormat.props.thousandsGroupStyle.description**: `string` = `"Thousand style (thousand) : 123,456,789, indian style (lakh) : 12,34,56,789, chinese style (wan) : 1,2345,6789"`

#### components.RsNumberFormat.props.thousandsGroupStyle.name[​](#componentsrsnumberformatpropsthousandsgroupstylename "Direct link to components.RsNumberFormat.props.thousandsGroupStyle.name")

> **components.RsNumberFormat.props.thousandsGroupStyle.name**: `string` = `"Thousands group style"`

#### components.RsPatternFormat[​](#componentsrspatternformat "Direct link to components.RsPatternFormat")

> **components.RsPatternFormat**: `object`

#### components.RsPatternFormat.description[​](#componentsrspatternformatdescription "Direct link to components.RsPatternFormat.description")

> **components.RsPatternFormat.description**: `string` = `"Pattern format input component with label support"`

#### components.RsPatternFormat.name[​](#componentsrspatternformatname "Direct link to components.RsPatternFormat.name")

> **components.RsPatternFormat.name**: `string` = `"Pattern format"`

#### components.RsPatternFormat.props[​](#componentsrspatternformatprops "Direct link to components.RsPatternFormat.props")

> **components.RsPatternFormat.props**: `object`

#### components.RsPatternFormat.props.allowEmptyFormatting[​](#componentsrspatternformatpropsallowemptyformatting "Direct link to components.RsPatternFormat.props.allowEmptyFormatting")

> **components.RsPatternFormat.props.allowEmptyFormatting**: `object`

#### components.RsPatternFormat.props.allowEmptyFormatting.description[​](#componentsrspatternformatpropsallowemptyformattingdescription "Direct link to components.RsPatternFormat.props.allowEmptyFormatting.description")

> **components.RsPatternFormat.props.allowEmptyFormatting.description**: `string` = `"By default PatternFormat component does not apply formatting when value is empty (null, undefined or ‘’)"`

#### components.RsPatternFormat.props.allowEmptyFormatting.name[​](#componentsrspatternformatpropsallowemptyformattingname "Direct link to components.RsPatternFormat.props.allowEmptyFormatting.name")

> **components.RsPatternFormat.props.allowEmptyFormatting.name**: `string` = `"Allow empty formatting"`

#### components.RsPatternFormat.props.format[​](#componentsrspatternformatpropsformat "Direct link to components.RsPatternFormat.props.format")

> **components.RsPatternFormat.props.format**: `object`

#### components.RsPatternFormat.props.format.description[​](#componentsrspatternformatpropsformatdescription "Direct link to components.RsPatternFormat.props.format.description")

> **components.RsPatternFormat.props.format.description**: `string` = `"Format pattern using the # (or a Pattern char) character. # is the placeholder character for numbers. Example: '### ###'"`

#### components.RsPatternFormat.props.format.name[​](#componentsrspatternformatpropsformatname "Direct link to components.RsPatternFormat.props.format.name")

> **components.RsPatternFormat.props.format.name**: `string` = `"Format"`

#### components.RsPatternFormat.props.mask[​](#componentsrspatternformatpropsmask "Direct link to components.RsPatternFormat.props.mask")

> **components.RsPatternFormat.props.mask**: `object`

#### components.RsPatternFormat.props.mask.description[​](#componentsrspatternformatpropsmaskdescription "Direct link to components.RsPatternFormat.props.mask.description")

> **components.RsPatternFormat.props.mask.description**: `string` = `"Used as mask character for numeric places, until any numeric character is provided for that position"`

#### components.RsPatternFormat.props.mask.name[​](#componentsrspatternformatpropsmaskname "Direct link to components.RsPatternFormat.props.mask.name")

> **components.RsPatternFormat.props.mask.name**: `string` = `"Mask"`

#### components.RsPatternFormat.props.patternChar[​](#componentsrspatternformatpropspatternchar "Direct link to components.RsPatternFormat.props.patternChar")

> **components.RsPatternFormat.props.patternChar**: `object`

#### components.RsPatternFormat.props.patternChar.description[​](#componentsrspatternformatpropspatternchardescription "Direct link to components.RsPatternFormat.props.patternChar.description")

> **components.RsPatternFormat.props.patternChar.description**: `string` = `"This helps define the format pattern character"`

#### components.RsPatternFormat.props.patternChar.name[​](#componentsrspatternformatpropspatterncharname "Direct link to components.RsPatternFormat.props.patternChar.name")

> **components.RsPatternFormat.props.patternChar.name**: `string` = `"Pattern char"`

#### components.RsPlaceholderGraph[​](#componentsrsplaceholdergraph "Direct link to components.RsPlaceholderGraph")

> **components.RsPlaceholderGraph**: `object`

#### components.RsPlaceholderGraph.description[​](#componentsrsplaceholdergraphdescription "Direct link to components.RsPlaceholderGraph.description")

> **components.RsPlaceholderGraph.description**: `string` = `"Placeholder before loading the component in the form of a rectangle"`

#### components.RsPlaceholderGraph.name[​](#componentsrsplaceholdergraphname "Direct link to components.RsPlaceholderGraph.name")

> **components.RsPlaceholderGraph.name**: `string` = `"Placeholder graph"`

#### components.RsPlaceholderGraph.props[​](#componentsrsplaceholdergraphprops "Direct link to components.RsPlaceholderGraph.props")

> **components.RsPlaceholderGraph.props**: `object`

#### components.RsPlaceholderGraph.props.active[​](#componentsrsplaceholdergraphpropsactive "Direct link to components.RsPlaceholderGraph.props.active")

> **components.RsPlaceholderGraph.props.active**: `object`

#### components.RsPlaceholderGraph.props.active.description[​](#componentsrsplaceholdergraphpropsactivedescription "Direct link to components.RsPlaceholderGraph.props.active.description")

> **components.RsPlaceholderGraph.props.active.description**: `string` = `"Whether the placeholder is active"`

#### components.RsPlaceholderGraph.props.active.name[​](#componentsrsplaceholdergraphpropsactivename "Direct link to components.RsPlaceholderGraph.props.active.name")

> **components.RsPlaceholderGraph.props.active.name**: `string` = `"Active"`

#### components.RsPlaceholderGraph.props.height[​](#componentsrsplaceholdergraphpropsheight "Direct link to components.RsPlaceholderGraph.props.height")

> **components.RsPlaceholderGraph.props.height**: `object`

#### components.RsPlaceholderGraph.props.height.description[​](#componentsrsplaceholdergraphpropsheightdescription "Direct link to components.RsPlaceholderGraph.props.height.description")

> **components.RsPlaceholderGraph.props.height.description**: `string` = `"The graph height"`

#### components.RsPlaceholderGraph.props.height.name[​](#componentsrsplaceholdergraphpropsheightname "Direct link to components.RsPlaceholderGraph.props.height.name")

> **components.RsPlaceholderGraph.props.height.name**: `string` = `"Height"`

#### components.RsPlaceholderGraph.props.width[​](#componentsrsplaceholdergraphpropswidth "Direct link to components.RsPlaceholderGraph.props.width")

> **components.RsPlaceholderGraph.props.width**: `object`

#### components.RsPlaceholderGraph.props.width.description[​](#componentsrsplaceholdergraphpropswidthdescription "Direct link to components.RsPlaceholderGraph.props.width.description")

> **components.RsPlaceholderGraph.props.width.description**: `string` = `"The graph width"`

#### components.RsPlaceholderGraph.props.width.name[​](#componentsrsplaceholdergraphpropswidthname "Direct link to components.RsPlaceholderGraph.props.width.name")

> **components.RsPlaceholderGraph.props.width.name**: `string` = `"Width"`

#### components.RsPlaceholderGrid[​](#componentsrsplaceholdergrid "Direct link to components.RsPlaceholderGrid")

> **components.RsPlaceholderGrid**: `object`

#### components.RsPlaceholderGrid.description[​](#componentsrsplaceholdergriddescription "Direct link to components.RsPlaceholderGrid.description")

> **components.RsPlaceholderGrid.description**: `string` = `"Placeholder before loading the component in the form of a grid"`

#### components.RsPlaceholderGrid.name[​](#componentsrsplaceholdergridname "Direct link to components.RsPlaceholderGrid.name")

> **components.RsPlaceholderGrid.name**: `string` = `"Placeholder grid"`

#### components.RsPlaceholderGrid.props[​](#componentsrsplaceholdergridprops "Direct link to components.RsPlaceholderGrid.props")

> **components.RsPlaceholderGrid.props**: `object`

#### components.RsPlaceholderGrid.props.active[​](#componentsrsplaceholdergridpropsactive "Direct link to components.RsPlaceholderGrid.props.active")

> **components.RsPlaceholderGrid.props.active**: `object`

#### components.RsPlaceholderGrid.props.active.description[​](#componentsrsplaceholdergridpropsactivedescription "Direct link to components.RsPlaceholderGrid.props.active.description")

> **components.RsPlaceholderGrid.props.active.description**: `string` = `"Whether the placeholder is active"`

#### components.RsPlaceholderGrid.props.active.name[​](#componentsrsplaceholdergridpropsactivename "Direct link to components.RsPlaceholderGrid.props.active.name")

> **components.RsPlaceholderGrid.props.active.name**: `string` = `"Active"`

#### components.RsPlaceholderGrid.props.columns[​](#componentsrsplaceholdergridpropscolumns "Direct link to components.RsPlaceholderGrid.props.columns")

> **components.RsPlaceholderGrid.props.columns**: `object`

#### components.RsPlaceholderGrid.props.columns.description[​](#componentsrsplaceholdergridpropscolumnsdescription "Direct link to components.RsPlaceholderGrid.props.columns.description")

> **components.RsPlaceholderGrid.props.columns.description**: `string` = `"The number of columns"`

#### components.RsPlaceholderGrid.props.columns.name[​](#componentsrsplaceholdergridpropscolumnsname "Direct link to components.RsPlaceholderGrid.props.columns.name")

> **components.RsPlaceholderGrid.props.columns.name**: `string` = `"Columns"`

#### components.RsPlaceholderGrid.props.rowHeight[​](#componentsrsplaceholdergridpropsrowheight "Direct link to components.RsPlaceholderGrid.props.rowHeight")

> **components.RsPlaceholderGrid.props.rowHeight**: `object`

#### components.RsPlaceholderGrid.props.rowHeight.description[​](#componentsrsplaceholdergridpropsrowheightdescription "Direct link to components.RsPlaceholderGrid.props.rowHeight.description")

> **components.RsPlaceholderGrid.props.rowHeight.description**: `string` = `"The height of the row"`

#### components.RsPlaceholderGrid.props.rowHeight.name[​](#componentsrsplaceholdergridpropsrowheightname "Direct link to components.RsPlaceholderGrid.props.rowHeight.name")

> **components.RsPlaceholderGrid.props.rowHeight.name**: `string` = `"Row height"`

#### components.RsPlaceholderGrid.props.rows[​](#componentsrsplaceholdergridpropsrows "Direct link to components.RsPlaceholderGrid.props.rows")

> **components.RsPlaceholderGrid.props.rows**: `object`

#### components.RsPlaceholderGrid.props.rows.description[​](#componentsrsplaceholdergridpropsrowsdescription "Direct link to components.RsPlaceholderGrid.props.rows.description")

> **components.RsPlaceholderGrid.props.rows.description**: `string` = `"The number of rows"`

#### components.RsPlaceholderGrid.props.rows.name[​](#componentsrsplaceholdergridpropsrowsname "Direct link to components.RsPlaceholderGrid.props.rows.name")

> **components.RsPlaceholderGrid.props.rows.name**: `string` = `"Rows"`

#### components.RsPlaceholderGrid.props.rowSpacing[​](#componentsrsplaceholdergridpropsrowspacing "Direct link to components.RsPlaceholderGrid.props.rowSpacing")

> **components.RsPlaceholderGrid.props.rowSpacing**: `object`

#### components.RsPlaceholderGrid.props.rowSpacing.description[​](#componentsrsplaceholdergridpropsrowspacingdescription "Direct link to components.RsPlaceholderGrid.props.rowSpacing.description")

> **components.RsPlaceholderGrid.props.rowSpacing.description**: `string` = `"The spacing between rows"`

#### components.RsPlaceholderGrid.props.rowSpacing.name[​](#componentsrsplaceholdergridpropsrowspacingname "Direct link to components.RsPlaceholderGrid.props.rowSpacing.name")

> **components.RsPlaceholderGrid.props.rowSpacing.name**: `string` = `"Row spacing"`

#### components.RsPlaceholderParagraph[​](#componentsrsplaceholderparagraph "Direct link to components.RsPlaceholderParagraph")

> **components.RsPlaceholderParagraph**: `object`

#### components.RsPlaceholderParagraph.description[​](#componentsrsplaceholderparagraphdescription "Direct link to components.RsPlaceholderParagraph.description")

> **components.RsPlaceholderParagraph.description**: `string` = `"Placeholder before loading the component in the form of a paragraph"`

#### components.RsPlaceholderParagraph.name[​](#componentsrsplaceholderparagraphname "Direct link to components.RsPlaceholderParagraph.name")

> **components.RsPlaceholderParagraph.name**: `string` = `"Placeholder paragraph"`

#### components.RsPlaceholderParagraph.props[​](#componentsrsplaceholderparagraphprops "Direct link to components.RsPlaceholderParagraph.props")

> **components.RsPlaceholderParagraph.props**: `object`

#### components.RsPlaceholderParagraph.props.active[​](#componentsrsplaceholderparagraphpropsactive "Direct link to components.RsPlaceholderParagraph.props.active")

> **components.RsPlaceholderParagraph.props.active**: `object`

#### components.RsPlaceholderParagraph.props.active.description[​](#componentsrsplaceholderparagraphpropsactivedescription "Direct link to components.RsPlaceholderParagraph.props.active.description")

> **components.RsPlaceholderParagraph.props.active.description**: `string` = `"Whether the placeholder is active"`

#### components.RsPlaceholderParagraph.props.active.name[​](#componentsrsplaceholderparagraphpropsactivename "Direct link to components.RsPlaceholderParagraph.props.active.name")

> **components.RsPlaceholderParagraph.props.active.name**: `string` = `"Active"`

#### components.RsPlaceholderParagraph.props.graph[​](#componentsrsplaceholderparagraphpropsgraph "Direct link to components.RsPlaceholderParagraph.props.graph")

> **components.RsPlaceholderParagraph.props.graph**: `object`

#### components.RsPlaceholderParagraph.props.graph.description[​](#componentsrsplaceholderparagraphpropsgraphdescription "Direct link to components.RsPlaceholderParagraph.props.graph.description")

> **components.RsPlaceholderParagraph.props.graph.description**: `string` = `"The shape of the graph"`

#### components.RsPlaceholderParagraph.props.graph.name[​](#componentsrsplaceholderparagraphpropsgraphname "Direct link to components.RsPlaceholderParagraph.props.graph.name")

> **components.RsPlaceholderParagraph.props.graph.name**: `string` = `"Graph"`

#### components.RsPlaceholderParagraph.props.rowHeight[​](#componentsrsplaceholderparagraphpropsrowheight "Direct link to components.RsPlaceholderParagraph.props.rowHeight")

> **components.RsPlaceholderParagraph.props.rowHeight**: `object`

#### components.RsPlaceholderParagraph.props.rowHeight.description[​](#componentsrsplaceholderparagraphpropsrowheightdescription "Direct link to components.RsPlaceholderParagraph.props.rowHeight.description")

> **components.RsPlaceholderParagraph.props.rowHeight.description**: `string` = `"The height of the row"`

#### components.RsPlaceholderParagraph.props.rowHeight.name[​](#componentsrsplaceholderparagraphpropsrowheightname "Direct link to components.RsPlaceholderParagraph.props.rowHeight.name")

> **components.RsPlaceholderParagraph.props.rowHeight.name**: `string` = `"Row height"`

#### components.RsPlaceholderParagraph.props.rows[​](#componentsrsplaceholderparagraphpropsrows "Direct link to components.RsPlaceholderParagraph.props.rows")

> **components.RsPlaceholderParagraph.props.rows**: `object`

#### components.RsPlaceholderParagraph.props.rows.description[​](#componentsrsplaceholderparagraphpropsrowsdescription "Direct link to components.RsPlaceholderParagraph.props.rows.description")

> **components.RsPlaceholderParagraph.props.rows.description**: `string` = `"The number of rows"`

#### components.RsPlaceholderParagraph.props.rows.name[​](#componentsrsplaceholderparagraphpropsrowsname "Direct link to components.RsPlaceholderParagraph.props.rows.name")

> **components.RsPlaceholderParagraph.props.rows.name**: `string` = `"Rows"`

#### components.RsPlaceholderParagraph.props.rowSpacing[​](#componentsrsplaceholderparagraphpropsrowspacing "Direct link to components.RsPlaceholderParagraph.props.rowSpacing")

> **components.RsPlaceholderParagraph.props.rowSpacing**: `object`

#### components.RsPlaceholderParagraph.props.rowSpacing.description[​](#componentsrsplaceholderparagraphpropsrowspacingdescription "Direct link to components.RsPlaceholderParagraph.props.rowSpacing.description")

> **components.RsPlaceholderParagraph.props.rowSpacing.description**: `string` = `"The spacing between rows"`

#### components.RsPlaceholderParagraph.props.rowSpacing.name[​](#componentsrsplaceholderparagraphpropsrowspacingname "Direct link to components.RsPlaceholderParagraph.props.rowSpacing.name")

> **components.RsPlaceholderParagraph.props.rowSpacing.name**: `string` = `"Row spacing"`

#### components.RsProgressCircle[​](#componentsrsprogresscircle "Direct link to components.RsProgressCircle")

> **components.RsProgressCircle**: `object`

#### components.RsProgressCircle.description[​](#componentsrsprogresscircledescription "Direct link to components.RsProgressCircle.description")

> **components.RsProgressCircle.description**: `string` = `"Displaying the current progress of an operation as a circle"`

#### components.RsProgressCircle.name[​](#componentsrsprogresscirclename "Direct link to components.RsProgressCircle.name")

> **components.RsProgressCircle.name**: `string` = `"Progress circle"`

#### components.RsProgressCircle.props[​](#componentsrsprogresscircleprops "Direct link to components.RsProgressCircle.props")

> **components.RsProgressCircle.props**: `object`

#### components.RsProgressCircle.props.classPrefix[​](#componentsrsprogresscirclepropsclassprefix "Direct link to components.RsProgressCircle.props.classPrefix")

> **components.RsProgressCircle.props.classPrefix**: `object`

#### components.RsProgressCircle.props.classPrefix.description[​](#componentsrsprogresscirclepropsclassprefixdescription "Direct link to components.RsProgressCircle.props.classPrefix.description")

> **components.RsProgressCircle.props.classPrefix.description**: `string` = `"The prefix of the component CSS class"`

#### components.RsProgressCircle.props.classPrefix.name[​](#componentsrsprogresscirclepropsclassprefixname "Direct link to components.RsProgressCircle.props.classPrefix.name")

> **components.RsProgressCircle.props.classPrefix.name**: `string` = `"Class prefix"`

#### components.RsProgressCircle.props.gapDegree[​](#componentsrsprogresscirclepropsgapdegree "Direct link to components.RsProgressCircle.props.gapDegree")

> **components.RsProgressCircle.props.gapDegree**: `object`

#### components.RsProgressCircle.props.gapDegree.description[​](#componentsrsprogresscirclepropsgapdegreedescription "Direct link to components.RsProgressCircle.props.gapDegree.description")

> **components.RsProgressCircle.props.gapDegree.description**: `string` = `"The gap degree of half circle, 0 ~ 360"`

#### components.RsProgressCircle.props.gapDegree.name[​](#componentsrsprogresscirclepropsgapdegreename "Direct link to components.RsProgressCircle.props.gapDegree.name")

> **components.RsProgressCircle.props.gapDegree.name**: `string` = `"Gap degree"`

#### components.RsProgressCircle.props.gapPosition[​](#componentsrsprogresscirclepropsgapposition "Direct link to components.RsProgressCircle.props.gapPosition")

> **components.RsProgressCircle.props.gapPosition**: `object`

#### components.RsProgressCircle.props.gapPosition.description[​](#componentsrsprogresscirclepropsgappositiondescription "Direct link to components.RsProgressCircle.props.gapPosition.description")

> **components.RsProgressCircle.props.gapPosition.description**: `string` = `"Circular progress bar Notch position"`

#### components.RsProgressCircle.props.gapPosition.name[​](#componentsrsprogresscirclepropsgappositionname "Direct link to components.RsProgressCircle.props.gapPosition.name")

> **components.RsProgressCircle.props.gapPosition.name**: `string` = `"Gap position"`

#### components.RsProgressCircle.props.percent[​](#componentsrsprogresscirclepropspercent "Direct link to components.RsProgressCircle.props.percent")

> **components.RsProgressCircle.props.percent**: `object`

#### components.RsProgressCircle.props.percent.description[​](#componentsrsprogresscirclepropspercentdescription "Direct link to components.RsProgressCircle.props.percent.description")

> **components.RsProgressCircle.props.percent.description**: `string` = `"Percent of progress"`

#### components.RsProgressCircle.props.percent.name[​](#componentsrsprogresscirclepropspercentname "Direct link to components.RsProgressCircle.props.percent.name")

> **components.RsProgressCircle.props.percent.name**: `string` = `"Percent"`

#### components.RsProgressCircle.props.showInfo[​](#componentsrsprogresscirclepropsshowinfo "Direct link to components.RsProgressCircle.props.showInfo")

> **components.RsProgressCircle.props.showInfo**: `object`

#### components.RsProgressCircle.props.showInfo.description[​](#componentsrsprogresscirclepropsshowinfodescription "Direct link to components.RsProgressCircle.props.showInfo.description")

> **components.RsProgressCircle.props.showInfo.description**: `string` = `"Show text"`

#### components.RsProgressCircle.props.showInfo.name[​](#componentsrsprogresscirclepropsshowinfoname "Direct link to components.RsProgressCircle.props.showInfo.name")

> **components.RsProgressCircle.props.showInfo.name**: `string` = `"Show info"`

#### components.RsProgressCircle.props.status[​](#componentsrsprogresscirclepropsstatus "Direct link to components.RsProgressCircle.props.status")

> **components.RsProgressCircle.props.status**: `object`

#### components.RsProgressCircle.props.status.description[​](#componentsrsprogresscirclepropsstatusdescription "Direct link to components.RsProgressCircle.props.status.description")

> **components.RsProgressCircle.props.status.description**: `string` = `"Progress status"`

#### components.RsProgressCircle.props.status.name[​](#componentsrsprogresscirclepropsstatusname "Direct link to components.RsProgressCircle.props.status.name")

> **components.RsProgressCircle.props.status.name**: `string` = `"Status"`

#### components.RsProgressCircle.props.strokeColor[​](#componentsrsprogresscirclepropsstrokecolor "Direct link to components.RsProgressCircle.props.strokeColor")

> **components.RsProgressCircle.props.strokeColor**: `object`

#### components.RsProgressCircle.props.strokeColor.description[​](#componentsrsprogresscirclepropsstrokecolordescription "Direct link to components.RsProgressCircle.props.strokeColor.description")

> **components.RsProgressCircle.props.strokeColor.description**: `string` = `"Line color"`

#### components.RsProgressCircle.props.strokeColor.name[​](#componentsrsprogresscirclepropsstrokecolorname "Direct link to components.RsProgressCircle.props.strokeColor.name")

> **components.RsProgressCircle.props.strokeColor.name**: `string` = `"Stroke color"`

#### components.RsProgressCircle.props.strokeLinecap[​](#componentsrsprogresscirclepropsstrokelinecap "Direct link to components.RsProgressCircle.props.strokeLinecap")

> **components.RsProgressCircle.props.strokeLinecap**: `object`

#### components.RsProgressCircle.props.strokeLinecap.description[​](#componentsrsprogresscirclepropsstrokelinecapdescription "Direct link to components.RsProgressCircle.props.strokeLinecap.description")

> **components.RsProgressCircle.props.strokeLinecap.description**: `string` = `"The end of different types of open paths"`

#### components.RsProgressCircle.props.strokeLinecap.name[​](#componentsrsprogresscirclepropsstrokelinecapname "Direct link to components.RsProgressCircle.props.strokeLinecap.name")

> **components.RsProgressCircle.props.strokeLinecap.name**: `string` = `"Stroke linecap"`

#### components.RsProgressCircle.props.strokeWidth[​](#componentsrsprogresscirclepropsstrokewidth "Direct link to components.RsProgressCircle.props.strokeWidth")

> **components.RsProgressCircle.props.strokeWidth**: `object`

#### components.RsProgressCircle.props.strokeWidth.description[​](#componentsrsprogresscirclepropsstrokewidthdescription "Direct link to components.RsProgressCircle.props.strokeWidth.description")

> **components.RsProgressCircle.props.strokeWidth.description**: `string` = `"Line width"`

#### components.RsProgressCircle.props.strokeWidth.name[​](#componentsrsprogresscirclepropsstrokewidthname "Direct link to components.RsProgressCircle.props.strokeWidth.name")

> **components.RsProgressCircle.props.strokeWidth.name**: `string` = `"Stroke width"`

#### components.RsProgressCircle.props.trailColor[​](#componentsrsprogresscirclepropstrailcolor "Direct link to components.RsProgressCircle.props.trailColor")

> **components.RsProgressCircle.props.trailColor**: `object`

#### components.RsProgressCircle.props.trailColor.description[​](#componentsrsprogresscirclepropstrailcolordescription "Direct link to components.RsProgressCircle.props.trailColor.description")

> **components.RsProgressCircle.props.trailColor.description**: `string` = `"Trail color"`

#### components.RsProgressCircle.props.trailColor.name[​](#componentsrsprogresscirclepropstrailcolorname "Direct link to components.RsProgressCircle.props.trailColor.name")

> **components.RsProgressCircle.props.trailColor.name**: `string` = `"Trail color"`

#### components.RsProgressCircle.props.trailWidth[​](#componentsrsprogresscirclepropstrailwidth "Direct link to components.RsProgressCircle.props.trailWidth")

> **components.RsProgressCircle.props.trailWidth**: `object`

#### components.RsProgressCircle.props.trailWidth.description[​](#componentsrsprogresscirclepropstrailwidthdescription "Direct link to components.RsProgressCircle.props.trailWidth.description")

> **components.RsProgressCircle.props.trailWidth.description**: `string` = `"Trail width"`

#### components.RsProgressCircle.props.trailWidth.name[​](#componentsrsprogresscirclepropstrailwidthname "Direct link to components.RsProgressCircle.props.trailWidth.name")

> **components.RsProgressCircle.props.trailWidth.name**: `string` = `"Trail width"`

#### components.RsProgressLine[​](#componentsrsprogressline "Direct link to components.RsProgressLine")

> **components.RsProgressLine**: `object`

#### components.RsProgressLine.description[​](#componentsrsprogresslinedescription "Direct link to components.RsProgressLine.description")

> **components.RsProgressLine.description**: `string` = `"Displaying the current progress of an operation as a line"`

#### components.RsProgressLine.name[​](#componentsrsprogresslinename "Direct link to components.RsProgressLine.name")

> **components.RsProgressLine.name**: `string` = `"Progress line"`

#### components.RsProgressLine.props[​](#componentsrsprogresslineprops "Direct link to components.RsProgressLine.props")

> **components.RsProgressLine.props**: `object`

#### components.RsProgressLine.props.classPrefix[​](#componentsrsprogresslinepropsclassprefix "Direct link to components.RsProgressLine.props.classPrefix")

> **components.RsProgressLine.props.classPrefix**: `object`

#### components.RsProgressLine.props.classPrefix.description[​](#componentsrsprogresslinepropsclassprefixdescription "Direct link to components.RsProgressLine.props.classPrefix.description")

> **components.RsProgressLine.props.classPrefix.description**: `string` = `"The prefix of the component CSS class"`

#### components.RsProgressLine.props.classPrefix.name[​](#componentsrsprogresslinepropsclassprefixname "Direct link to components.RsProgressLine.props.classPrefix.name")

> **components.RsProgressLine.props.classPrefix.name**: `string` = `"Class prefix"`

#### components.RsProgressLine.props.percent[​](#componentsrsprogresslinepropspercent "Direct link to components.RsProgressLine.props.percent")

> **components.RsProgressLine.props.percent**: `object`

#### components.RsProgressLine.props.percent.description[​](#componentsrsprogresslinepropspercentdescription "Direct link to components.RsProgressLine.props.percent.description")

> **components.RsProgressLine.props.percent.description**: `string` = `"Percent of progress"`

#### components.RsProgressLine.props.percent.name[​](#componentsrsprogresslinepropspercentname "Direct link to components.RsProgressLine.props.percent.name")

> **components.RsProgressLine.props.percent.name**: `string` = `"Percent"`

#### components.RsProgressLine.props.showInfo[​](#componentsrsprogresslinepropsshowinfo "Direct link to components.RsProgressLine.props.showInfo")

> **components.RsProgressLine.props.showInfo**: `object`

#### components.RsProgressLine.props.showInfo.description[​](#componentsrsprogresslinepropsshowinfodescription "Direct link to components.RsProgressLine.props.showInfo.description")

> **components.RsProgressLine.props.showInfo.description**: `string` = `"Show text"`

#### components.RsProgressLine.props.showInfo.name[​](#componentsrsprogresslinepropsshowinfoname "Direct link to components.RsProgressLine.props.showInfo.name")

> **components.RsProgressLine.props.showInfo.name**: `string` = `"Show info"`

#### components.RsProgressLine.props.status[​](#componentsrsprogresslinepropsstatus "Direct link to components.RsProgressLine.props.status")

> **components.RsProgressLine.props.status**: `object`

#### components.RsProgressLine.props.status.description[​](#componentsrsprogresslinepropsstatusdescription "Direct link to components.RsProgressLine.props.status.description")

> **components.RsProgressLine.props.status.description**: `string` = `"Progress status"`

#### components.RsProgressLine.props.status.name[​](#componentsrsprogresslinepropsstatusname "Direct link to components.RsProgressLine.props.status.name")

> **components.RsProgressLine.props.status.name**: `string` = `"Status"`

#### components.RsProgressLine.props.strokeColor[​](#componentsrsprogresslinepropsstrokecolor "Direct link to components.RsProgressLine.props.strokeColor")

> **components.RsProgressLine.props.strokeColor**: `object`

#### components.RsProgressLine.props.strokeColor.description[​](#componentsrsprogresslinepropsstrokecolordescription "Direct link to components.RsProgressLine.props.strokeColor.description")

> **components.RsProgressLine.props.strokeColor.description**: `string` = `"Line color"`

#### components.RsProgressLine.props.strokeColor.name[​](#componentsrsprogresslinepropsstrokecolorname "Direct link to components.RsProgressLine.props.strokeColor.name")

> **components.RsProgressLine.props.strokeColor.name**: `string` = `"Stroke color"`

#### components.RsProgressLine.props.strokeWidth[​](#componentsrsprogresslinepropsstrokewidth "Direct link to components.RsProgressLine.props.strokeWidth")

> **components.RsProgressLine.props.strokeWidth**: `object`

#### components.RsProgressLine.props.strokeWidth.description[​](#componentsrsprogresslinepropsstrokewidthdescription "Direct link to components.RsProgressLine.props.strokeWidth.description")

> **components.RsProgressLine.props.strokeWidth.description**: `string` = `"Line width"`

#### components.RsProgressLine.props.strokeWidth.name[​](#componentsrsprogresslinepropsstrokewidthname "Direct link to components.RsProgressLine.props.strokeWidth.name")

> **components.RsProgressLine.props.strokeWidth.name**: `string` = `"Stroke width"`

#### components.RsProgressLine.props.vertical[​](#componentsrsprogresslinepropsvertical "Direct link to components.RsProgressLine.props.vertical")

> **components.RsProgressLine.props.vertical**: `object`

#### components.RsProgressLine.props.vertical.description[​](#componentsrsprogresslinepropsverticaldescription "Direct link to components.RsProgressLine.props.vertical.description")

> **components.RsProgressLine.props.vertical.description**: `string` = `"The progress bar is displayed vertically"`

#### components.RsProgressLine.props.vertical.name[​](#componentsrsprogresslinepropsverticalname "Direct link to components.RsProgressLine.props.vertical.name")

> **components.RsProgressLine.props.vertical.name**: `string` = `"Vertical"`

#### components.RsRadioGroup[​](#componentsrsradiogroup "Direct link to components.RsRadioGroup")

> **components.RsRadioGroup**: `object`

#### components.RsRadioGroup.description[​](#componentsrsradiogroupdescription "Direct link to components.RsRadioGroup.description")

> **components.RsRadioGroup.description**: `string` = `"Radios are used when only one choice may be selected in a series of options"`

#### components.RsRadioGroup.name[​](#componentsrsradiogroupname "Direct link to components.RsRadioGroup.name")

> **components.RsRadioGroup.name**: `string` = `"Radio group"`

#### components.RsRadioGroup.props[​](#componentsrsradiogroupprops "Direct link to components.RsRadioGroup.props")

> **components.RsRadioGroup.props**: `object`

#### components.RsRadioGroup.props.appearance[​](#componentsrsradiogrouppropsappearance "Direct link to components.RsRadioGroup.props.appearance")

> **components.RsRadioGroup.props.appearance**: `object`

#### components.RsRadioGroup.props.appearance.description[​](#componentsrsradiogrouppropsappearancedescription "Direct link to components.RsRadioGroup.props.appearance.description")

> **components.RsRadioGroup.props.appearance.description**: `string` = `"A radio group can have different appearances"`

#### components.RsRadioGroup.props.appearance.name[​](#componentsrsradiogrouppropsappearancename "Direct link to components.RsRadioGroup.props.appearance.name")

> **components.RsRadioGroup.props.appearance.name**: `string` = `"Appearance"`

#### components.RsRadioGroup.props.inline[​](#componentsrsradiogrouppropsinline "Direct link to components.RsRadioGroup.props.inline")

> **components.RsRadioGroup.props.inline**: `object`

#### components.RsRadioGroup.props.inline.description[​](#componentsrsradiogrouppropsinlinedescription "Direct link to components.RsRadioGroup.props.inline.description")

> **components.RsRadioGroup.props.inline.description**: `string` = `"Inline layout"`

#### components.RsRadioGroup.props.inline.name[​](#componentsrsradiogrouppropsinlinename "Direct link to components.RsRadioGroup.props.inline.name")

> **components.RsRadioGroup.props.inline.name**: `string` = `"Inline"`

#### components.RsRadioGroup.props.items[​](#componentsrsradiogrouppropsitems "Direct link to components.RsRadioGroup.props.items")

> **components.RsRadioGroup.props.items**: `object`

#### components.RsRadioGroup.props.items.description[​](#componentsrsradiogrouppropsitemsdescription "Direct link to components.RsRadioGroup.props.items.description")

> **components.RsRadioGroup.props.items.description**: `string` = `"The items for the radio group"`

#### components.RsRadioGroup.props.items.name[​](#componentsrsradiogrouppropsitemsname "Direct link to components.RsRadioGroup.props.items.name")

> **components.RsRadioGroup.props.items.name**: `string` = `"Items"`

#### components.RsRadioGroup.props.name[​](#componentsrsradiogrouppropsname "Direct link to components.RsRadioGroup.props.name")

> **components.RsRadioGroup.props.name**: `object`

#### components.RsRadioGroup.props.name.description[​](#componentsrsradiogrouppropsnamedescription "Direct link to components.RsRadioGroup.props.name.description")

> **components.RsRadioGroup.props.name.description**: `string` = `"Radio group name"`

#### components.RsRadioGroup.props.name.name[​](#componentsrsradiogrouppropsnamename "Direct link to components.RsRadioGroup.props.name.name")

> **components.RsRadioGroup.props.name.name**: `string` = `"Name"`

#### components.RsRadioGroup.props.onChange[​](#componentsrsradiogrouppropsonchange "Direct link to components.RsRadioGroup.props.onChange")

> **components.RsRadioGroup.props.onChange**: `object`

#### components.RsRadioGroup.props.onChange.description[​](#componentsrsradiogrouppropsonchangedescription "Direct link to components.RsRadioGroup.props.onChange.description")

> **components.RsRadioGroup.props.onChange.description**: `string` = `"Called after the value has been changed"`

#### components.RsRadioGroup.props.onChange.name[​](#componentsrsradiogrouppropsonchangename "Direct link to components.RsRadioGroup.props.onChange.name")

> **components.RsRadioGroup.props.onChange.name**: `string` = `"onChange"`

#### components.RsSearch[​](#componentsrssearch "Direct link to components.RsSearch")

> **components.RsSearch**: `object`

#### components.RsSearch.description[​](#componentsrssearchdescription "Direct link to components.RsSearch.description")

> **components.RsSearch.description**: `string` = `"Search component with label and data loading support"`

#### components.RsSearch.name[​](#componentsrssearchname "Direct link to components.RsSearch.name")

> **components.RsSearch.name**: `string` = `"Search"`

#### components.RsSearch.props[​](#componentsrssearchprops "Direct link to components.RsSearch.props")

> **components.RsSearch.props**: `object`

#### components.RsSearch.props.cleanable[​](#componentsrssearchpropscleanable "Direct link to components.RsSearch.props.cleanable")

> **components.RsSearch.props.cleanable**: `object`

#### components.RsSearch.props.cleanable.description[​](#componentsrssearchpropscleanabledescription "Direct link to components.RsSearch.props.cleanable.description")

> **components.RsSearch.props.cleanable.description**: `string` = `"Whether the option can be emptied"`

#### components.RsSearch.props.cleanable.name[​](#componentsrssearchpropscleanablename "Direct link to components.RsSearch.props.cleanable.name")

> **components.RsSearch.props.cleanable.name**: `string` = `"Cleanable"`

#### components.RsSearch.props.creatable[​](#componentsrssearchpropscreatable "Direct link to components.RsSearch.props.creatable")

> **components.RsSearch.props.creatable**: `object`

#### components.RsSearch.props.creatable.description[​](#componentsrssearchpropscreatabledescription "Direct link to components.RsSearch.props.creatable.description")

> **components.RsSearch.props.creatable.description**: `string` = `"Settings can create new options"`

#### components.RsSearch.props.creatable.name[​](#componentsrssearchpropscreatablename "Direct link to components.RsSearch.props.creatable.name")

> **components.RsSearch.props.creatable.name**: `string` = `"Creatable"`

#### components.RsSearch.props.data[​](#componentsrssearchpropsdata "Direct link to components.RsSearch.props.data")

> **components.RsSearch.props.data**: `object`

#### components.RsSearch.props.data.description[​](#componentsrssearchpropsdatadescription "Direct link to components.RsSearch.props.data.description")

> **components.RsSearch.props.data.description**: `string` = `"Selectable data"`

#### components.RsSearch.props.data.name[​](#componentsrssearchpropsdataname "Direct link to components.RsSearch.props.data.name")

> **components.RsSearch.props.data.name**: `string` = `"Data"`

#### components.RsSearch.props.disableVirtualized[​](#componentsrssearchpropsdisablevirtualized "Direct link to components.RsSearch.props.disableVirtualized")

> **components.RsSearch.props.disableVirtualized**: `object`

#### components.RsSearch.props.disableVirtualized.description[​](#componentsrssearchpropsdisablevirtualizeddescription "Direct link to components.RsSearch.props.disableVirtualized.description")

> **components.RsSearch.props.disableVirtualized.description**: `string` = `"Whether to disable virtualization"`

#### components.RsSearch.props.disableVirtualized.name[​](#componentsrssearchpropsdisablevirtualizedname "Direct link to components.RsSearch.props.disableVirtualized.name")

> **components.RsSearch.props.disableVirtualized.name**: `string` = `"Disable virtualized"`

#### components.RsSearch.props.groupBy[​](#componentsrssearchpropsgroupby "Direct link to components.RsSearch.props.groupBy")

> **components.RsSearch.props.groupBy**: `object`

#### components.RsSearch.props.groupBy.description[​](#componentsrssearchpropsgroupbydescription "Direct link to components.RsSearch.props.groupBy.description")

> **components.RsSearch.props.groupBy.description**: `string` = `"Set grouping criteria 'key' in 'data'"`

#### components.RsSearch.props.groupBy.name[​](#componentsrssearchpropsgroupbyname "Direct link to components.RsSearch.props.groupBy.name")

> **components.RsSearch.props.groupBy.name**: `string` = `"Group by"`

#### components.RsSearch.props.onChange[​](#componentsrssearchpropsonchange "Direct link to components.RsSearch.props.onChange")

> **components.RsSearch.props.onChange**: `object`

#### components.RsSearch.props.onChange.description[​](#componentsrssearchpropsonchangedescription "Direct link to components.RsSearch.props.onChange.description")

> **components.RsSearch.props.onChange.description**: `string` = `"Callback function when value changes"`

#### components.RsSearch.props.onChange.name[​](#componentsrssearchpropsonchangename "Direct link to components.RsSearch.props.onChange.name")

> **components.RsSearch.props.onChange.name**: `string` = `"onChange"`

#### components.RsSearch.props.onClean[​](#componentsrssearchpropsonclean "Direct link to components.RsSearch.props.onClean")

> **components.RsSearch.props.onClean**: `object`

#### components.RsSearch.props.onClean.description[​](#componentsrssearchpropsoncleandescription "Direct link to components.RsSearch.props.onClean.description")

> **components.RsSearch.props.onClean.description**: `string` = `"The callback for clean"`

#### components.RsSearch.props.onClean.name[​](#componentsrssearchpropsoncleanname "Direct link to components.RsSearch.props.onClean.name")

> **components.RsSearch.props.onClean.name**: `string` = `"onClean"`

#### components.RsSearch.props.onClose[​](#componentsrssearchpropsonclose "Direct link to components.RsSearch.props.onClose")

> **components.RsSearch.props.onClose**: `object`

#### components.RsSearch.props.onClose.description[​](#componentsrssearchpropsonclosedescription "Direct link to components.RsSearch.props.onClose.description")

> **components.RsSearch.props.onClose.description**: `string` = `"The callback for close"`

#### components.RsSearch.props.onClose.name[​](#componentsrssearchpropsonclosename "Direct link to components.RsSearch.props.onClose.name")

> **components.RsSearch.props.onClose.name**: `string` = `"onClose"`

#### components.RsSearch.props.onCreate[​](#componentsrssearchpropsoncreate "Direct link to components.RsSearch.props.onCreate")

> **components.RsSearch.props.onCreate**: `object`

#### components.RsSearch.props.onCreate.description[​](#componentsrssearchpropsoncreatedescription "Direct link to components.RsSearch.props.onCreate.description")

> **components.RsSearch.props.onCreate.description**: `string` = `"The callback for create"`

#### components.RsSearch.props.onCreate.name[​](#componentsrssearchpropsoncreatename "Direct link to components.RsSearch.props.onCreate.name")

> **components.RsSearch.props.onCreate.name**: `string` = `"onCreate"`

#### components.RsSearch.props.onLoadData[​](#componentsrssearchpropsonloaddata "Direct link to components.RsSearch.props.onLoadData")

> **components.RsSearch.props.onLoadData**: `object`

#### components.RsSearch.props.onLoadData.description[​](#componentsrssearchpropsonloaddatadescription "Direct link to components.RsSearch.props.onLoadData.description")

> **components.RsSearch.props.onLoadData.description**: `string` = `"The callback for loading data"`

#### components.RsSearch.props.onLoadData.name[​](#componentsrssearchpropsonloaddataname "Direct link to components.RsSearch.props.onLoadData.name")

> **components.RsSearch.props.onLoadData.name**: `string` = `"onLoadData"`

#### components.RsSearch.props.onSearch[​](#componentsrssearchpropsonsearch "Direct link to components.RsSearch.props.onSearch")

> **components.RsSearch.props.onSearch**: `object`

#### components.RsSearch.props.onSearch.description[​](#componentsrssearchpropsonsearchdescription "Direct link to components.RsSearch.props.onSearch.description")

> **components.RsSearch.props.onSearch.description**: `string` = `"The callback for search"`

#### components.RsSearch.props.onSearch.name[​](#componentsrssearchpropsonsearchname "Direct link to components.RsSearch.props.onSearch.name")

> **components.RsSearch.props.onSearch.name**: `string` = `"onSearch"`

#### components.RsSearch.props.onSelect[​](#componentsrssearchpropsonselect "Direct link to components.RsSearch.props.onSelect")

> **components.RsSearch.props.onSelect**: `object`

#### components.RsSearch.props.onSelect.description[​](#componentsrssearchpropsonselectdescription "Direct link to components.RsSearch.props.onSelect.description")

> **components.RsSearch.props.onSelect.description**: `string` = `"The callback for select"`

#### components.RsSearch.props.onSelect.name[​](#componentsrssearchpropsonselectname "Direct link to components.RsSearch.props.onSelect.name")

> **components.RsSearch.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsSearch.props.preload[​](#componentsrssearchpropspreload "Direct link to components.RsSearch.props.preload")

> **components.RsSearch.props.preload**: `object`

#### components.RsSearch.props.preload.description[​](#componentsrssearchpropspreloaddescription "Direct link to components.RsSearch.props.preload.description")

> **components.RsSearch.props.preload.description**: `string` = `"Whether to preload data"`

#### components.RsSearch.props.preload.name[​](#componentsrssearchpropspreloadname "Direct link to components.RsSearch.props.preload.name")

> **components.RsSearch.props.preload.name**: `string` = `"Preload"`

#### components.RsStaticContent[​](#componentsrsstaticcontent "Direct link to components.RsStaticContent")

> **components.RsStaticContent**: `object`

#### components.RsStaticContent.description[​](#componentsrsstaticcontentdescription "Direct link to components.RsStaticContent.description")

> **components.RsStaticContent.description**: `string` = `"A static content component that displays text or HTML content"`

#### components.RsStaticContent.name[​](#componentsrsstaticcontentname "Direct link to components.RsStaticContent.name")

> **components.RsStaticContent.name**: `string` = `"Static content"`

#### components.RsStaticContent.props[​](#componentsrsstaticcontentprops "Direct link to components.RsStaticContent.props")

> **components.RsStaticContent.props**: `object`

#### components.RsStaticContent.props.allowHtml[​](#componentsrsstaticcontentpropsallowhtml "Direct link to components.RsStaticContent.props.allowHtml")

> **components.RsStaticContent.props.allowHtml**: `object`

#### components.RsStaticContent.props.allowHtml.description[​](#componentsrsstaticcontentpropsallowhtmldescription "Direct link to components.RsStaticContent.props.allowHtml.description")

> **components.RsStaticContent.props.allowHtml.description**: `string` = `"Whether to allow HTML content"`

#### components.RsStaticContent.props.allowHtml.name[​](#componentsrsstaticcontentpropsallowhtmlname "Direct link to components.RsStaticContent.props.allowHtml.name")

> **components.RsStaticContent.props.allowHtml.name**: `string` = `"Allow HTML"`

#### components.RsStaticContent.props.content[​](#componentsrsstaticcontentpropscontent "Direct link to components.RsStaticContent.props.content")

> **components.RsStaticContent.props.content**: `object`

#### components.RsStaticContent.props.content.description[​](#componentsrsstaticcontentpropscontentdescription "Direct link to components.RsStaticContent.props.content.description")

> **components.RsStaticContent.props.content.description**: `string` = `"The content to display"`

#### components.RsStaticContent.props.content.name[​](#componentsrsstaticcontentpropscontentname "Direct link to components.RsStaticContent.props.content.name")

> **components.RsStaticContent.props.content.name**: `string` = `"Content"`

#### components.RsTab[​](#componentsrstab "Direct link to components.RsTab")

> **components.RsTab**: `object`

#### components.RsTab.description[​](#componentsrstabdescription "Direct link to components.RsTab.description")

> **components.RsTab.description**: `string` = `"Tabs are a set of layered sections of content, known as tab panels, that display one panel of content at a time"`

#### components.RsTab.name[​](#componentsrstabname "Direct link to components.RsTab.name")

> **components.RsTab.name**: `string` = `"Tab"`

#### components.RsTab.props[​](#componentsrstabprops "Direct link to components.RsTab.props")

> **components.RsTab.props**: `object`

#### components.RsTab.props.activeKey[​](#componentsrstabpropsactivekey "Direct link to components.RsTab.props.activeKey")

> **components.RsTab.props.activeKey**: `object`

#### components.RsTab.props.activeKey.description[​](#componentsrstabpropsactivekeydescription "Direct link to components.RsTab.props.activeKey.description")

> **components.RsTab.props.activeKey.description**: `string` = `"Active key, corresponding to one of items value"`

#### components.RsTab.props.activeKey.name[​](#componentsrstabpropsactivekeyname "Direct link to components.RsTab.props.activeKey.name")

> **components.RsTab.props.activeKey.name**: `string` = `"Active key"`

#### components.RsTab.props.appearance[​](#componentsrstabpropsappearance "Direct link to components.RsTab.props.appearance")

> **components.RsTab.props.appearance**: `object`

#### components.RsTab.props.appearance.description[​](#componentsrstabpropsappearancedescription "Direct link to components.RsTab.props.appearance.description")

> **components.RsTab.props.appearance.description**: `string` = `"A tab can have different appearances"`

#### components.RsTab.props.appearance.name[​](#componentsrstabpropsappearancename "Direct link to components.RsTab.props.appearance.name")

> **components.RsTab.props.appearance.name**: `string` = `"Appearance"`

#### components.RsTab.props.items[​](#componentsrstabpropsitems "Direct link to components.RsTab.props.items")

> **components.RsTab.props.items**: `object`

#### components.RsTab.props.items.description[​](#componentsrstabpropsitemsdescription "Direct link to components.RsTab.props.items.description")

> **components.RsTab.props.items.description**: `string` = `"Items for the tab"`

#### components.RsTab.props.items.name[​](#componentsrstabpropsitemsname "Direct link to components.RsTab.props.items.name")

> **components.RsTab.props.items.name**: `string` = `"Items"`

#### components.RsTab.props.justified[​](#componentsrstabpropsjustified "Direct link to components.RsTab.props.justified")

> **components.RsTab.props.justified**: `object`

#### components.RsTab.props.justified.description[​](#componentsrstabpropsjustifieddescription "Direct link to components.RsTab.props.justified.description")

> **components.RsTab.props.justified.description**: `string` = `"Justified navigation"`

#### components.RsTab.props.justified.name[​](#componentsrstabpropsjustifiedname "Direct link to components.RsTab.props.justified.name")

> **components.RsTab.props.justified.name**: `string` = `"Justified"`

#### components.RsTab.props.onSelect[​](#componentsrstabpropsonselect "Direct link to components.RsTab.props.onSelect")

> **components.RsTab.props.onSelect**: `object`

#### components.RsTab.props.onSelect.description[​](#componentsrstabpropsonselectdescription "Direct link to components.RsTab.props.onSelect.description")

> **components.RsTab.props.onSelect.description**: `string` = `"Callback function triggered after selection"`

#### components.RsTab.props.onSelect.name[​](#componentsrstabpropsonselectname "Direct link to components.RsTab.props.onSelect.name")

> **components.RsTab.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsTab.props.pane[​](#componentsrstabpropspane "Direct link to components.RsTab.props.pane")

> **components.RsTab.props.pane**: `object`

#### components.RsTab.props.pane.description[​](#componentsrstabpropspanedescription "Direct link to components.RsTab.props.pane.description")

> **components.RsTab.props.pane.description**: `string` = `"A child component of the tab"`

#### components.RsTab.props.pane.name[​](#componentsrstabpropspanename "Direct link to components.RsTab.props.pane.name")

> **components.RsTab.props.pane.name**: `string` = `"Pane"`

#### components.RsTab.props.reversed[​](#componentsrstabpropsreversed "Direct link to components.RsTab.props.reversed")

> **components.RsTab.props.reversed**: `object`

#### components.RsTab.props.reversed.description[​](#componentsrstabpropsreverseddescription "Direct link to components.RsTab.props.reversed.description")

> **components.RsTab.props.reversed.description**: `string` = `"Reverse direction of tabs/subtle"`

#### components.RsTab.props.reversed.name[​](#componentsrstabpropsreversedname "Direct link to components.RsTab.props.reversed.name")

> **components.RsTab.props.reversed.name**: `string` = `"Reversed"`

#### components.RsTab.props.showNavigation[​](#componentsrstabpropsshownavigation "Direct link to components.RsTab.props.showNavigation")

> **components.RsTab.props.showNavigation**: `object`

#### components.RsTab.props.showNavigation.description[​](#componentsrstabpropsshownavigationdescription "Direct link to components.RsTab.props.showNavigation.description")

> **components.RsTab.props.showNavigation.description**: `string` = `"Show or hide navigation"`

#### components.RsTab.props.showNavigation.name[​](#componentsrstabpropsshownavigationname "Direct link to components.RsTab.props.showNavigation.name")

> **components.RsTab.props.showNavigation.name**: `string` = `"Show navigation"`

#### components.RsTab.props.vertical[​](#componentsrstabpropsvertical "Direct link to components.RsTab.props.vertical")

> **components.RsTab.props.vertical**: `object`

#### components.RsTab.props.vertical.description[​](#componentsrstabpropsverticaldescription "Direct link to components.RsTab.props.vertical.description")

> **components.RsTab.props.vertical.description**: `string` = `"Stacked navigation"`

#### components.RsTab.props.vertical.name[​](#componentsrstabpropsverticalname "Direct link to components.RsTab.props.vertical.name")

> **components.RsTab.props.vertical.name**: `string` = `"Vertical"`

#### components.RsTagPicker[​](#componentsrstagpicker "Direct link to components.RsTagPicker")

> **components.RsTagPicker**: `object`

#### components.RsTagPicker.description[​](#componentsrstagpickerdescription "Direct link to components.RsTagPicker.description")

> **components.RsTagPicker.description**: `string` = `"Tag picker component with label support"`

#### components.RsTagPicker.name[​](#componentsrstagpickername "Direct link to components.RsTagPicker.name")

> **components.RsTagPicker.name**: `string` = `"Tag picker"`

#### components.RsTagPicker.props[​](#componentsrstagpickerprops "Direct link to components.RsTagPicker.props")

> **components.RsTagPicker.props**: `object`

#### components.RsTagPicker.props.cleanable[​](#componentsrstagpickerpropscleanable "Direct link to components.RsTagPicker.props.cleanable")

> **components.RsTagPicker.props.cleanable**: `object`

#### components.RsTagPicker.props.cleanable.description[​](#componentsrstagpickerpropscleanabledescription "Direct link to components.RsTagPicker.props.cleanable.description")

> **components.RsTagPicker.props.cleanable.description**: `string` = `"Whether the option can be emptied"`

#### components.RsTagPicker.props.cleanable.name[​](#componentsrstagpickerpropscleanablename "Direct link to components.RsTagPicker.props.cleanable.name")

> **components.RsTagPicker.props.cleanable.name**: `string` = `"Cleanable"`

#### components.RsTagPicker.props.creatable[​](#componentsrstagpickerpropscreatable "Direct link to components.RsTagPicker.props.creatable")

> **components.RsTagPicker.props.creatable**: `object`

#### components.RsTagPicker.props.creatable.description[​](#componentsrstagpickerpropscreatabledescription "Direct link to components.RsTagPicker.props.creatable.description")

> **components.RsTagPicker.props.creatable.description**: `string` = `"Settings can create new options"`

#### components.RsTagPicker.props.creatable.name[​](#componentsrstagpickerpropscreatablename "Direct link to components.RsTagPicker.props.creatable.name")

> **components.RsTagPicker.props.creatable.name**: `string` = `"Creatable"`

#### components.RsTagPicker.props.data[​](#componentsrstagpickerpropsdata "Direct link to components.RsTagPicker.props.data")

> **components.RsTagPicker.props.data**: `object`

#### components.RsTagPicker.props.data.description[​](#componentsrstagpickerpropsdatadescription "Direct link to components.RsTagPicker.props.data.description")

> **components.RsTagPicker.props.data.description**: `string` = `"Selectable data"`

#### components.RsTagPicker.props.data.name[​](#componentsrstagpickerpropsdataname "Direct link to components.RsTagPicker.props.data.name")

> **components.RsTagPicker.props.data.name**: `string` = `"Data"`

#### components.RsTagPicker.props.groupBy[​](#componentsrstagpickerpropsgroupby "Direct link to components.RsTagPicker.props.groupBy")

> **components.RsTagPicker.props.groupBy**: `object`

#### components.RsTagPicker.props.groupBy.description[​](#componentsrstagpickerpropsgroupbydescription "Direct link to components.RsTagPicker.props.groupBy.description")

> **components.RsTagPicker.props.groupBy.description**: `string` = `"Set grouping criteria 'key' in 'data'"`

#### components.RsTagPicker.props.groupBy.name[​](#componentsrstagpickerpropsgroupbyname "Direct link to components.RsTagPicker.props.groupBy.name")

> **components.RsTagPicker.props.groupBy.name**: `string` = `"Group by"`

#### components.RsTagPicker.props.onChange[​](#componentsrstagpickerpropsonchange "Direct link to components.RsTagPicker.props.onChange")

> **components.RsTagPicker.props.onChange**: `object`

#### components.RsTagPicker.props.onChange.description[​](#componentsrstagpickerpropsonchangedescription "Direct link to components.RsTagPicker.props.onChange.description")

> **components.RsTagPicker.props.onChange.description**: `string` = `"Callback function when value changes"`

#### components.RsTagPicker.props.onChange.name[​](#componentsrstagpickerpropsonchangename "Direct link to components.RsTagPicker.props.onChange.name")

> **components.RsTagPicker.props.onChange.name**: `string` = `"onChange"`

#### components.RsTagPicker.props.onClean[​](#componentsrstagpickerpropsonclean "Direct link to components.RsTagPicker.props.onClean")

> **components.RsTagPicker.props.onClean**: `object`

#### components.RsTagPicker.props.onClean.description[​](#componentsrstagpickerpropsoncleandescription "Direct link to components.RsTagPicker.props.onClean.description")

> **components.RsTagPicker.props.onClean.description**: `string` = `"The callback for clean"`

#### components.RsTagPicker.props.onClean.name[​](#componentsrstagpickerpropsoncleanname "Direct link to components.RsTagPicker.props.onClean.name")

> **components.RsTagPicker.props.onClean.name**: `string` = `"onClean"`

#### components.RsTagPicker.props.onClose[​](#componentsrstagpickerpropsonclose "Direct link to components.RsTagPicker.props.onClose")

> **components.RsTagPicker.props.onClose**: `object`

#### components.RsTagPicker.props.onClose.description[​](#componentsrstagpickerpropsonclosedescription "Direct link to components.RsTagPicker.props.onClose.description")

> **components.RsTagPicker.props.onClose.description**: `string` = `"The callback for close"`

#### components.RsTagPicker.props.onClose.name[​](#componentsrstagpickerpropsonclosename "Direct link to components.RsTagPicker.props.onClose.name")

> **components.RsTagPicker.props.onClose.name**: `string` = `"onClose"`

#### components.RsTagPicker.props.onCreate[​](#componentsrstagpickerpropsoncreate "Direct link to components.RsTagPicker.props.onCreate")

> **components.RsTagPicker.props.onCreate**: `object`

#### components.RsTagPicker.props.onCreate.description[​](#componentsrstagpickerpropsoncreatedescription "Direct link to components.RsTagPicker.props.onCreate.description")

> **components.RsTagPicker.props.onCreate.description**: `string` = `"The callback for create"`

#### components.RsTagPicker.props.onCreate.name[​](#componentsrstagpickerpropsoncreatename "Direct link to components.RsTagPicker.props.onCreate.name")

> **components.RsTagPicker.props.onCreate.name**: `string` = `"onCreate"`

#### components.RsTagPicker.props.onSearch[​](#componentsrstagpickerpropsonsearch "Direct link to components.RsTagPicker.props.onSearch")

> **components.RsTagPicker.props.onSearch**: `object`

#### components.RsTagPicker.props.onSearch.description[​](#componentsrstagpickerpropsonsearchdescription "Direct link to components.RsTagPicker.props.onSearch.description")

> **components.RsTagPicker.props.onSearch.description**: `string` = `"The callback for search"`

#### components.RsTagPicker.props.onSearch.name[​](#componentsrstagpickerpropsonsearchname "Direct link to components.RsTagPicker.props.onSearch.name")

> **components.RsTagPicker.props.onSearch.name**: `string` = `"onSearch"`

#### components.RsTagPicker.props.onSelect[​](#componentsrstagpickerpropsonselect "Direct link to components.RsTagPicker.props.onSelect")

> **components.RsTagPicker.props.onSelect**: `object`

#### components.RsTagPicker.props.onSelect.description[​](#componentsrstagpickerpropsonselectdescription "Direct link to components.RsTagPicker.props.onSelect.description")

> **components.RsTagPicker.props.onSelect.description**: `string` = `"The callback for select"`

#### components.RsTagPicker.props.onSelect.name[​](#componentsrstagpickerpropsonselectname "Direct link to components.RsTagPicker.props.onSelect.name")

> **components.RsTagPicker.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsTextArea[​](#componentsrstextarea "Direct link to components.RsTextArea")

> **components.RsTextArea**: `object`

#### components.RsTextArea.description[​](#componentsrstextareadescription "Direct link to components.RsTextArea.description")

> **components.RsTextArea.description**: `string` = `"A text area component for multi-line text input"`

#### components.RsTextArea.name[​](#componentsrstextareaname "Direct link to components.RsTextArea.name")

> **components.RsTextArea.name**: `string` = `"Text area"`

#### components.RsTextArea.props[​](#componentsrstextareaprops "Direct link to components.RsTextArea.props")

> **components.RsTextArea.props**: `object`

#### components.RsTextArea.props.onChange[​](#componentsrstextareapropsonchange "Direct link to components.RsTextArea.props.onChange")

> **components.RsTextArea.props.onChange**: `object`

#### components.RsTextArea.props.onChange.description[​](#componentsrstextareapropsonchangedescription "Direct link to components.RsTextArea.props.onChange.description")

> **components.RsTextArea.props.onChange.description**: `string` = `"The callback function in which value is changed"`

#### components.RsTextArea.props.onChange.name[​](#componentsrstextareapropsonchangename "Direct link to components.RsTextArea.props.onChange.name")

> **components.RsTextArea.props.onChange.name**: `string` = `"onChange"`

#### components.RsTextArea.props.onPressEnter[​](#componentsrstextareapropsonpressenter "Direct link to components.RsTextArea.props.onPressEnter")

> **components.RsTextArea.props.onPressEnter**: `object`

#### components.RsTextArea.props.onPressEnter.description[​](#componentsrstextareapropsonpressenterdescription "Direct link to components.RsTextArea.props.onPressEnter.description")

> **components.RsTextArea.props.onPressEnter.description**: `string` = `"Called on press enter"`

#### components.RsTextArea.props.onPressEnter.name[​](#componentsrstextareapropsonpressentername "Direct link to components.RsTextArea.props.onPressEnter.name")

> **components.RsTextArea.props.onPressEnter.name**: `string` = `"onPressEnter"`

#### components.RsTextArea.props.rows[​](#componentsrstextareapropsrows "Direct link to components.RsTextArea.props.rows")

> **components.RsTextArea.props.rows**: `object`

#### components.RsTextArea.props.rows.description[​](#componentsrstextareapropsrowsdescription "Direct link to components.RsTextArea.props.rows.description")

> **components.RsTextArea.props.rows.description**: `string` = `"The number of visible text lines"`

#### components.RsTextArea.props.rows.name[​](#componentsrstextareapropsrowsname "Direct link to components.RsTextArea.props.rows.name")

> **components.RsTextArea.props.rows.name**: `string` = `"Rows"`

#### components.RsTimePicker[​](#componentsrstimepicker "Direct link to components.RsTimePicker")

> **components.RsTimePicker**: `object`

#### components.RsTimePicker.description[​](#componentsrstimepickerdescription "Direct link to components.RsTimePicker.description")

> **components.RsTimePicker.description**: `string` = `"Time picker component with label support"`

#### components.RsTimePicker.name[​](#componentsrstimepickername "Direct link to components.RsTimePicker.name")

> **components.RsTimePicker.name**: `string` = `"Time picker"`

#### components.RsTimePicker.props[​](#componentsrstimepickerprops "Direct link to components.RsTimePicker.props")

> **components.RsTimePicker.props**: `object`

#### components.RsTimePicker.props.cleanable[​](#componentsrstimepickerpropscleanable "Direct link to components.RsTimePicker.props.cleanable")

> **components.RsTimePicker.props.cleanable**: `object`

#### components.RsTimePicker.props.cleanable.description[​](#componentsrstimepickerpropscleanabledescription "Direct link to components.RsTimePicker.props.cleanable.description")

> **components.RsTimePicker.props.cleanable.description**: `string` = `"Whether the selected value can be cleared"`

#### components.RsTimePicker.props.cleanable.name[​](#componentsrstimepickerpropscleanablename "Direct link to components.RsTimePicker.props.cleanable.name")

> **components.RsTimePicker.props.cleanable.name**: `string` = `"Cleanable"`

#### components.RsTimePicker.props.defaultValue[​](#componentsrstimepickerpropsdefaultvalue "Direct link to components.RsTimePicker.props.defaultValue")

> **components.RsTimePicker.props.defaultValue**: `object`

#### components.RsTimePicker.props.defaultValue.description[​](#componentsrstimepickerpropsdefaultvaluedescription "Direct link to components.RsTimePicker.props.defaultValue.description")

> **components.RsTimePicker.props.defaultValue.description**: `string` = `"Default value"`

#### components.RsTimePicker.props.defaultValue.name[​](#componentsrstimepickerpropsdefaultvaluename "Direct link to components.RsTimePicker.props.defaultValue.name")

> **components.RsTimePicker.props.defaultValue.name**: `string` = `"Default value"`

#### components.RsTimePicker.props.editable[​](#componentsrstimepickerpropseditable "Direct link to components.RsTimePicker.props.editable")

> **components.RsTimePicker.props.editable**: `object`

#### components.RsTimePicker.props.editable.description[​](#componentsrstimepickerpropseditabledescription "Direct link to components.RsTimePicker.props.editable.description")

> **components.RsTimePicker.props.editable.description**: `string` = `"Rendered as an input, the time can be entered via the keyboard"`

#### components.RsTimePicker.props.editable.name[​](#componentsrstimepickerpropseditablename "Direct link to components.RsTimePicker.props.editable.name")

> **components.RsTimePicker.props.editable.name**: `string` = `"Editable"`

#### components.RsTimePicker.props.format[​](#componentsrstimepickerpropsformat "Direct link to components.RsTimePicker.props.format")

> **components.RsTimePicker.props.format**: `object`

#### components.RsTimePicker.props.format.description[​](#componentsrstimepickerpropsformatdescription "Direct link to components.RsTimePicker.props.format.description")

> **components.RsTimePicker.props.format.description**: `string` = `"Format of the time when rendered in the input"`

#### components.RsTimePicker.props.format.name[​](#componentsrstimepickerpropsformatname "Direct link to components.RsTimePicker.props.format.name")

> **components.RsTimePicker.props.format.name**: `string` = `"Format"`

#### components.RsTimePicker.props.onChange[​](#componentsrstimepickerpropsonchange "Direct link to components.RsTimePicker.props.onChange")

> **components.RsTimePicker.props.onChange**: `object`

#### components.RsTimePicker.props.onChange.description[​](#componentsrstimepickerpropsonchangedescription "Direct link to components.RsTimePicker.props.onChange.description")

> **components.RsTimePicker.props.onChange.description**: `string` = `"Callback fired when value changed"`

#### components.RsTimePicker.props.onChange.name[​](#componentsrstimepickerpropsonchangename "Direct link to components.RsTimePicker.props.onChange.name")

> **components.RsTimePicker.props.onChange.name**: `string` = `"onChange"`

#### components.RsTimePicker.props.onClean[​](#componentsrstimepickerpropsonclean "Direct link to components.RsTimePicker.props.onClean")

> **components.RsTimePicker.props.onClean**: `object`

#### components.RsTimePicker.props.onClean.description[​](#componentsrstimepickerpropsoncleandescription "Direct link to components.RsTimePicker.props.onClean.description")

> **components.RsTimePicker.props.onClean.description**: `string` = `"Callback fired when value clean"`

#### components.RsTimePicker.props.onClean.name[​](#componentsrstimepickerpropsoncleanname "Direct link to components.RsTimePicker.props.onClean.name")

> **components.RsTimePicker.props.onClean.name**: `string` = `"onClean"`

#### components.RsTimePicker.props.onClose[​](#componentsrstimepickerpropsonclose "Direct link to components.RsTimePicker.props.onClose")

> **components.RsTimePicker.props.onClose**: `object`

#### components.RsTimePicker.props.onClose.description[​](#componentsrstimepickerpropsonclosedescription "Direct link to components.RsTimePicker.props.onClose.description")

> **components.RsTimePicker.props.onClose.description**: `string` = `"Callback fired when close component"`

#### components.RsTimePicker.props.onClose.name[​](#componentsrstimepickerpropsonclosename "Direct link to components.RsTimePicker.props.onClose.name")

> **components.RsTimePicker.props.onClose.name**: `string` = `"onClose"`

#### components.RsTimePicker.props.onEnter[​](#componentsrstimepickerpropsonenter "Direct link to components.RsTimePicker.props.onEnter")

> **components.RsTimePicker.props.onEnter**: `object`

#### components.RsTimePicker.props.onEnter.description[​](#componentsrstimepickerpropsonenterdescription "Direct link to components.RsTimePicker.props.onEnter.description")

> **components.RsTimePicker.props.onEnter.description**: `string` = `"Callback fired before the overlay transitions in"`

#### components.RsTimePicker.props.onEnter.name[​](#componentsrstimepickerpropsonentername "Direct link to components.RsTimePicker.props.onEnter.name")

> **components.RsTimePicker.props.onEnter.name**: `string` = `"onEnter"`

#### components.RsTimePicker.props.onEntered[​](#componentsrstimepickerpropsonentered "Direct link to components.RsTimePicker.props.onEntered")

> **components.RsTimePicker.props.onEntered**: `object`

#### components.RsTimePicker.props.onEntered.description[​](#componentsrstimepickerpropsonentereddescription "Direct link to components.RsTimePicker.props.onEntered.description")

> **components.RsTimePicker.props.onEntered.description**: `string` = `"Callback fired after the overlay finishes transitioning in"`

#### components.RsTimePicker.props.onEntered.name[​](#componentsrstimepickerpropsonenteredname "Direct link to components.RsTimePicker.props.onEntered.name")

> **components.RsTimePicker.props.onEntered.name**: `string` = `"onEntered"`

#### components.RsTimePicker.props.onEntering[​](#componentsrstimepickerpropsonentering "Direct link to components.RsTimePicker.props.onEntering")

> **components.RsTimePicker.props.onEntering**: `object`

#### components.RsTimePicker.props.onEntering.description[​](#componentsrstimepickerpropsonenteringdescription "Direct link to components.RsTimePicker.props.onEntering.description")

> **components.RsTimePicker.props.onEntering.description**: `string` = `"Callback fired as the overlay begins to transition in"`

#### components.RsTimePicker.props.onEntering.name[​](#componentsrstimepickerpropsonenteringname "Direct link to components.RsTimePicker.props.onEntering.name")

> **components.RsTimePicker.props.onEntering.name**: `string` = `"onEntering"`

#### components.RsTimePicker.props.onExit[​](#componentsrstimepickerpropsonexit "Direct link to components.RsTimePicker.props.onExit")

> **components.RsTimePicker.props.onExit**: `object`

#### components.RsTimePicker.props.onExit.description[​](#componentsrstimepickerpropsonexitdescription "Direct link to components.RsTimePicker.props.onExit.description")

> **components.RsTimePicker.props.onExit.description**: `string` = `"Callback fired right before the overlay transitions out"`

#### components.RsTimePicker.props.onExit.name[​](#componentsrstimepickerpropsonexitname "Direct link to components.RsTimePicker.props.onExit.name")

> **components.RsTimePicker.props.onExit.name**: `string` = `"onExit"`

#### components.RsTimePicker.props.onExited[​](#componentsrstimepickerpropsonexited "Direct link to components.RsTimePicker.props.onExited")

> **components.RsTimePicker.props.onExited**: `object`

#### components.RsTimePicker.props.onExited.description[​](#componentsrstimepickerpropsonexiteddescription "Direct link to components.RsTimePicker.props.onExited.description")

> **components.RsTimePicker.props.onExited.description**: `string` = `"Callback fired after the overlay finishes transitioning out"`

#### components.RsTimePicker.props.onExited.name[​](#componentsrstimepickerpropsonexitedname "Direct link to components.RsTimePicker.props.onExited.name")

> **components.RsTimePicker.props.onExited.name**: `string` = `"onExited"`

#### components.RsTimePicker.props.onExiting[​](#componentsrstimepickerpropsonexiting "Direct link to components.RsTimePicker.props.onExiting")

> **components.RsTimePicker.props.onExiting**: `object`

#### components.RsTimePicker.props.onExiting.description[​](#componentsrstimepickerpropsonexitingdescription "Direct link to components.RsTimePicker.props.onExiting.description")

> **components.RsTimePicker.props.onExiting.description**: `string` = `"Callback fired as the overlay begins to transition out"`

#### components.RsTimePicker.props.onExiting.name[​](#componentsrstimepickerpropsonexitingname "Direct link to components.RsTimePicker.props.onExiting.name")

> **components.RsTimePicker.props.onExiting.name**: `string` = `"onExiting"`

#### components.RsTimePicker.props.onOk[​](#componentsrstimepickerpropsonok "Direct link to components.RsTimePicker.props.onOk")

> **components.RsTimePicker.props.onOk**: `object`

#### components.RsTimePicker.props.onOk.description[​](#componentsrstimepickerpropsonokdescription "Direct link to components.RsTimePicker.props.onOk.description")

> **components.RsTimePicker.props.onOk.description**: `string` = `"Click the OK callback function"`

#### components.RsTimePicker.props.onOk.name[​](#componentsrstimepickerpropsonokname "Direct link to components.RsTimePicker.props.onOk.name")

> **components.RsTimePicker.props.onOk.name**: `string` = `"onOk"`

#### components.RsTimePicker.props.onOpen[​](#componentsrstimepickerpropsonopen "Direct link to components.RsTimePicker.props.onOpen")

> **components.RsTimePicker.props.onOpen**: `object`

#### components.RsTimePicker.props.onOpen.description[​](#componentsrstimepickerpropsonopendescription "Direct link to components.RsTimePicker.props.onOpen.description")

> **components.RsTimePicker.props.onOpen.description**: `string` = `"Callback fired when open component"`

#### components.RsTimePicker.props.onOpen.name[​](#componentsrstimepickerpropsonopenname "Direct link to components.RsTimePicker.props.onOpen.name")

> **components.RsTimePicker.props.onOpen.name**: `string` = `"onOpen"`

#### components.RsTimePicker.props.onSelect[​](#componentsrstimepickerpropsonselect "Direct link to components.RsTimePicker.props.onSelect")

> **components.RsTimePicker.props.onSelect**: `object`

#### components.RsTimePicker.props.onSelect.description[​](#componentsrstimepickerpropsonselectdescription "Direct link to components.RsTimePicker.props.onSelect.description")

> **components.RsTimePicker.props.onSelect.description**: `string` = `"Callback fired when date or time is selected"`

#### components.RsTimePicker.props.onSelect.name[​](#componentsrstimepickerpropsonselectname "Direct link to components.RsTimePicker.props.onSelect.name")

> **components.RsTimePicker.props.onSelect.name**: `string` = `"onSelect"`

#### components.RsTimePicker.props.open[​](#componentsrstimepickerpropsopen "Direct link to components.RsTimePicker.props.open")

> **components.RsTimePicker.props.open**: `object`

#### components.RsTimePicker.props.open.description[​](#componentsrstimepickerpropsopendescription "Direct link to components.RsTimePicker.props.open.description")

> **components.RsTimePicker.props.open.description**: `string` = `"Whether open the component"`

#### components.RsTimePicker.props.open.name[​](#componentsrstimepickerpropsopenname "Direct link to components.RsTimePicker.props.open.name")

> **components.RsTimePicker.props.open.name**: `string` = `"Open"`

#### components.RsToggle[​](#componentsrstoggle "Direct link to components.RsToggle")

> **components.RsToggle**: `object`

#### components.RsToggle.description[​](#componentsrstoggledescription "Direct link to components.RsToggle.description")

> **components.RsToggle.description**: `string` = `"Toggle switch, used for selection between two values"`

#### components.RsToggle.name[​](#componentsrstogglename "Direct link to components.RsToggle.name")

> **components.RsToggle.name**: `string` = `"Toggle"`

#### components.RsToggle.props[​](#componentsrstoggleprops "Direct link to components.RsToggle.props")

> **components.RsToggle.props**: `object`

#### components.RsToggle.props.checked[​](#componentsrstogglepropschecked "Direct link to components.RsToggle.props.checked")

> **components.RsToggle.props.checked**: `object`

#### components.RsToggle.props.checked.description[​](#componentsrstogglepropscheckeddescription "Direct link to components.RsToggle.props.checked.description")

> **components.RsToggle.props.checked.description**: `string` = `"Whether the toggle is checked"`

#### components.RsToggle.props.checked.name[​](#componentsrstogglepropscheckedname "Direct link to components.RsToggle.props.checked.name")

> **components.RsToggle.props.checked.name**: `string` = `"Checked"`

#### components.RsToggle.props.checkedChildren[​](#componentsrstogglepropscheckedchildren "Direct link to components.RsToggle.props.checkedChildren")

> **components.RsToggle.props.checkedChildren**: `object`

#### components.RsToggle.props.checkedChildren.description[​](#componentsrstogglepropscheckedchildrendescription "Direct link to components.RsToggle.props.checkedChildren.description")

> **components.RsToggle.props.checkedChildren.description**: `string` = `"The text that is displayed in the checked state"`

#### components.RsToggle.props.checkedChildren.name[​](#componentsrstogglepropscheckedchildrenname "Direct link to components.RsToggle.props.checkedChildren.name")

> **components.RsToggle.props.checkedChildren.name**: `string` = `"Checked text"`

#### components.RsToggle.props.children[​](#componentsrstogglepropschildren "Direct link to components.RsToggle.props.children")

> **components.RsToggle.props.children**: `object`

#### components.RsToggle.props.children.description[​](#componentsrstogglepropschildrendescription "Direct link to components.RsToggle.props.children.description")

> **components.RsToggle.props.children.description**: `string` = `"The component label"`

#### components.RsToggle.props.children.name[​](#componentsrstogglepropschildrenname "Direct link to components.RsToggle.props.children.name")

> **components.RsToggle.props.children.name**: `string` = `"Label"`

#### components.RsToggle.props.color[​](#componentsrstogglepropscolor "Direct link to components.RsToggle.props.color")

> **components.RsToggle.props.color**: `object`

#### components.RsToggle.props.color.description[​](#componentsrstogglepropscolordescription "Direct link to components.RsToggle.props.color.description")

> **components.RsToggle.props.color.description**: `string` = `"The color of the toggle"`

#### components.RsToggle.props.color.name[​](#componentsrstogglepropscolorname "Direct link to components.RsToggle.props.color.name")

> **components.RsToggle.props.color.name**: `string` = `"Color"`

#### components.RsToggle.props.loading[​](#componentsrstogglepropsloading "Direct link to components.RsToggle.props.loading")

> **components.RsToggle.props.loading**: `object`

#### components.RsToggle.props.loading.description[​](#componentsrstogglepropsloadingdescription "Direct link to components.RsToggle.props.loading.description")

> **components.RsToggle.props.loading.description**: `string` = `"Whether the component is in loading state"`

#### components.RsToggle.props.loading.name[​](#componentsrstogglepropsloadingname "Direct link to components.RsToggle.props.loading.name")

> **components.RsToggle.props.loading.name**: `string` = `"Loading"`

#### components.RsToggle.props.onChange[​](#componentsrstogglepropsonchange "Direct link to components.RsToggle.props.onChange")

> **components.RsToggle.props.onChange**: `object`

#### components.RsToggle.props.onChange.description[​](#componentsrstogglepropsonchangedescription "Direct link to components.RsToggle.props.onChange.description")

> **components.RsToggle.props.onChange.description**: `string` = `"Called when the state of the toggle changes"`

#### components.RsToggle.props.onChange.name[​](#componentsrstogglepropsonchangename "Direct link to components.RsToggle.props.onChange.name")

> **components.RsToggle.props.onChange.name**: `string` = `"onChange"`

#### components.RsToggle.props.unCheckedChildren[​](#componentsrstogglepropsuncheckedchildren "Direct link to components.RsToggle.props.unCheckedChildren")

> **components.RsToggle.props.unCheckedChildren**: `object`

#### components.RsToggle.props.unCheckedChildren.description[​](#componentsrstogglepropsuncheckedchildrendescription "Direct link to components.RsToggle.props.unCheckedChildren.description")

> **components.RsToggle.props.unCheckedChildren.description**: `string` = `"The text that is displayed in the unchecked state"`

#### components.RsToggle.props.unCheckedChildren.name[​](#componentsrstogglepropsuncheckedchildrenname "Direct link to components.RsToggle.props.unCheckedChildren.name")

> **components.RsToggle.props.unCheckedChildren.name**: `string` = `"Unchecked text"`

#### components.RsTooltip[​](#componentsrstooltip "Direct link to components.RsTooltip")

> **components.RsTooltip**: `object`

#### components.RsTooltip.description[​](#componentsrstooltipdescription "Direct link to components.RsTooltip.description")

> **components.RsTooltip.description**: `string` = `"A text tip for secondary, which replaces the default title property of an HTML element"`

#### components.RsTooltip.name[​](#componentsrstooltipname "Direct link to components.RsTooltip.name")

> **components.RsTooltip.name**: `string` = `"Tooltip"`

#### components.RsTooltip.props[​](#componentsrstooltipprops "Direct link to components.RsTooltip.props")

> **components.RsTooltip.props**: `object`

#### components.RsTooltip.props.children[​](#componentsrstooltippropschildren "Direct link to components.RsTooltip.props.children")

> **components.RsTooltip.props.children**: `object`

#### components.RsTooltip.props.children.description[​](#componentsrstooltippropschildrendescription "Direct link to components.RsTooltip.props.children.description")

> **components.RsTooltip.props.children.description**: `string` = `"Child element of a tooltip"`

#### components.RsTooltip.props.children.name[​](#componentsrstooltippropschildrenname "Direct link to components.RsTooltip.props.children.name")

> **components.RsTooltip.props.children.name**: `string` = `"Children"`

#### components.RsTooltip.props.text[​](#componentsrstooltippropstext "Direct link to components.RsTooltip.props.text")

> **components.RsTooltip.props.text**: `object`

#### components.RsTooltip.props.text.description[​](#componentsrstooltippropstextdescription "Direct link to components.RsTooltip.props.text.description")

> **components.RsTooltip.props.text.description**: `string` = `"Tooltip text"`

#### components.RsTooltip.props.text.name[​](#componentsrstooltippropstextname "Direct link to components.RsTooltip.props.text.name")

> **components.RsTooltip.props.text.name**: `string` = `"Text"`

#### components.RsTooltip.props.trigger[​](#componentsrstooltippropstrigger "Direct link to components.RsTooltip.props.trigger")

> **components.RsTooltip.props.trigger**: `object`

#### components.RsTooltip.props.trigger.description[​](#componentsrstooltippropstriggerdescription "Direct link to components.RsTooltip.props.trigger.description")

> **components.RsTooltip.props.trigger.description**: `string` = `"The tooltip trigger"`

#### components.RsTooltip.props.trigger.name[​](#componentsrstooltippropstriggername "Direct link to components.RsTooltip.props.trigger.name")

> **components.RsTooltip.props.trigger.name**: `string` = `"Trigger"`

#### components.RsUploader[​](#componentsrsuploader "Direct link to components.RsUploader")

> **components.RsUploader**: `object`

#### components.RsUploader.description[​](#componentsrsuploaderdescription "Direct link to components.RsUploader.description")

> **components.RsUploader.description**: `string` = `"Upload files by clicking or drag-and-drop, it supports previewing the uploaded image"`

#### components.RsUploader.name[​](#componentsrsuploadername "Direct link to components.RsUploader.name")

> **components.RsUploader.name**: `string` = `"Uploader"`

#### components.RsUploader.props[​](#componentsrsuploaderprops "Direct link to components.RsUploader.props")

> **components.RsUploader.props**: `object`

#### components.RsUploader.props.accept[​](#componentsrsuploaderpropsaccept "Direct link to components.RsUploader.props.accept")

> **components.RsUploader.props.accept**: `object`

#### components.RsUploader.props.accept.description[​](#componentsrsuploaderpropsacceptdescription "Direct link to components.RsUploader.props.accept.description")

> **components.RsUploader.props.accept.description**: `string` = `"File types that can be accepted. See standard HTML attribute: accept"`

#### components.RsUploader.props.accept.name[​](#componentsrsuploaderpropsacceptname "Direct link to components.RsUploader.props.accept.name")

> **components.RsUploader.props.accept.name**: `string` = `"Accept"`

#### components.RsUploader.props.action[​](#componentsrsuploaderpropsaction "Direct link to components.RsUploader.props.action")

> **components.RsUploader.props.action**: `object`

#### components.RsUploader.props.action.description[​](#componentsrsuploaderpropsactiondescription "Direct link to components.RsUploader.props.action.description")

> **components.RsUploader.props.action.description**: `string` = `"Uploading URL"`

#### components.RsUploader.props.action.name[​](#componentsrsuploaderpropsactionname "Direct link to components.RsUploader.props.action.name")

> **components.RsUploader.props.action.name**: `string` = `"Action"`

#### components.RsUploader.props.autoUpload[​](#componentsrsuploaderpropsautoupload "Direct link to components.RsUploader.props.autoUpload")

> **components.RsUploader.props.autoUpload**: `object`

#### components.RsUploader.props.autoUpload.description[​](#componentsrsuploaderpropsautouploaddescription "Direct link to components.RsUploader.props.autoUpload.description")

> **components.RsUploader.props.autoUpload.description**: `string` = `"Automatically upload files after selecting them"`

#### components.RsUploader.props.autoUpload.name[​](#componentsrsuploaderpropsautouploadname "Direct link to components.RsUploader.props.autoUpload.name")

> **components.RsUploader.props.autoUpload.name**: `string` = `"Auto upload"`

#### components.RsUploader.props.children[​](#componentsrsuploaderpropschildren "Direct link to components.RsUploader.props.children")

> **components.RsUploader.props.children**: `object`

#### components.RsUploader.props.children.description[​](#componentsrsuploaderpropschildrendescription "Direct link to components.RsUploader.props.children.description")

> **components.RsUploader.props.children.description**: `string` = `"Primary content"`

#### components.RsUploader.props.children.name[​](#componentsrsuploaderpropschildrenname "Direct link to components.RsUploader.props.children.name")

> **components.RsUploader.props.children.name**: `string` = `"Children"`

#### components.RsUploader.props.customElement[​](#componentsrsuploaderpropscustomelement "Direct link to components.RsUploader.props.customElement")

> **components.RsUploader.props.customElement**: `object`

#### components.RsUploader.props.customElement.description[​](#componentsrsuploaderpropscustomelementdescription "Direct link to components.RsUploader.props.customElement.description")

> **components.RsUploader.props.customElement.description**: `string` = `"Whether to use a custom element for the uploader"`

#### components.RsUploader.props.customElement.name[​](#componentsrsuploaderpropscustomelementname "Direct link to components.RsUploader.props.customElement.name")

> **components.RsUploader.props.customElement.name**: `string` = `"Custom element"`

#### components.RsUploader.props.disabledFileItem[​](#componentsrsuploaderpropsdisabledfileitem "Direct link to components.RsUploader.props.disabledFileItem")

> **components.RsUploader.props.disabledFileItem**: `object`

#### components.RsUploader.props.disabledFileItem.description[​](#componentsrsuploaderpropsdisabledfileitemdescription "Direct link to components.RsUploader.props.disabledFileItem.description")

> **components.RsUploader.props.disabledFileItem.description**: `string` = `"Disabled file item"`

#### components.RsUploader.props.disabledFileItem.name[​](#componentsrsuploaderpropsdisabledfileitemname "Direct link to components.RsUploader.props.disabledFileItem.name")

> **components.RsUploader.props.disabledFileItem.name**: `string` = `"Disabled file item"`

#### components.RsUploader.props.disableMultipart[​](#componentsrsuploaderpropsdisablemultipart "Direct link to components.RsUploader.props.disableMultipart")

> **components.RsUploader.props.disableMultipart**: `object`

#### components.RsUploader.props.disableMultipart.description[​](#componentsrsuploaderpropsdisablemultipartdescription "Direct link to components.RsUploader.props.disableMultipart.description")

> **components.RsUploader.props.disableMultipart.description**: `string` = `"If 'true', disable using a multipart form for file upload and instead stream the file. Some APIs (e.g. Amazon S3) may expect the file to be streamed rather than sent via a form"`

#### components.RsUploader.props.disableMultipart.name[​](#componentsrsuploaderpropsdisablemultipartname "Direct link to components.RsUploader.props.disableMultipart.name")

> **components.RsUploader.props.disableMultipart.name**: `string` = `"Disable multipart"`

#### components.RsUploader.props.draggable[​](#componentsrsuploaderpropsdraggable "Direct link to components.RsUploader.props.draggable")

> **components.RsUploader.props.draggable**: `object`

#### components.RsUploader.props.draggable.description[​](#componentsrsuploaderpropsdraggabledescription "Direct link to components.RsUploader.props.draggable.description")

> **components.RsUploader.props.draggable.description**: `string` = `"Enabled drag and drop to upload"`

#### components.RsUploader.props.draggable.name[​](#componentsrsuploaderpropsdraggablename "Direct link to components.RsUploader.props.draggable.name")

> **components.RsUploader.props.draggable.name**: `string` = `"Draggable"`

#### components.RsUploader.props.fileList[​](#componentsrsuploaderpropsfilelist "Direct link to components.RsUploader.props.fileList")

> **components.RsUploader.props.fileList**: `object`

#### components.RsUploader.props.fileList.description[​](#componentsrsuploaderpropsfilelistdescription "Direct link to components.RsUploader.props.fileList.description")

> **components.RsUploader.props.fileList.description**: `string` = `"List of uploaded files"`

#### components.RsUploader.props.fileList.name[​](#componentsrsuploaderpropsfilelistname "Direct link to components.RsUploader.props.fileList.name")

> **components.RsUploader.props.fileList.name**: `string` = `"File list"`

#### components.RsUploader.props.fileListVisible[​](#componentsrsuploaderpropsfilelistvisible "Direct link to components.RsUploader.props.fileListVisible")

> **components.RsUploader.props.fileListVisible**: `object`

#### components.RsUploader.props.fileListVisible.description[​](#componentsrsuploaderpropsfilelistvisibledescription "Direct link to components.RsUploader.props.fileListVisible.description")

> **components.RsUploader.props.fileListVisible.description**: `string` = `"File list can be rendered"`

#### components.RsUploader.props.fileListVisible.name[​](#componentsrsuploaderpropsfilelistvisiblename "Direct link to components.RsUploader.props.fileListVisible.name")

> **components.RsUploader.props.fileListVisible.name**: `string` = `"File list visible"`

#### components.RsUploader.props.listType[​](#componentsrsuploaderpropslisttype "Direct link to components.RsUploader.props.listType")

> **components.RsUploader.props.listType**: `object`

#### components.RsUploader.props.listType.description[​](#componentsrsuploaderpropslisttypedescription "Direct link to components.RsUploader.props.listType.description")

> **components.RsUploader.props.listType.description**: `string` = `"Upload list style"`

#### components.RsUploader.props.listType.name[​](#componentsrsuploaderpropslisttypename "Direct link to components.RsUploader.props.listType.name")

> **components.RsUploader.props.listType.name**: `string` = `"List type"`

#### components.RsUploader.props.method[​](#componentsrsuploaderpropsmethod "Direct link to components.RsUploader.props.method")

> **components.RsUploader.props.method**: `object`

#### components.RsUploader.props.method.description[​](#componentsrsuploaderpropsmethoddescription "Direct link to components.RsUploader.props.method.description")

> **components.RsUploader.props.method.description**: `string` = `"The HTTP method of upload request"`

#### components.RsUploader.props.method.name[​](#componentsrsuploaderpropsmethodname "Direct link to components.RsUploader.props.method.name")

> **components.RsUploader.props.method.name**: `string` = `"Method"`

#### components.RsUploader.props.multiple[​](#componentsrsuploaderpropsmultiple "Direct link to components.RsUploader.props.multiple")

> **components.RsUploader.props.multiple**: `object`

#### components.RsUploader.props.multiple.description[​](#componentsrsuploaderpropsmultipledescription "Direct link to components.RsUploader.props.multiple.description")

> **components.RsUploader.props.multiple.description**: `string` = `"Allow multiple file uploads"`

#### components.RsUploader.props.multiple.name[​](#componentsrsuploaderpropsmultiplename "Direct link to components.RsUploader.props.multiple.name")

> **components.RsUploader.props.multiple.name**: `string` = `"Multiple"`

#### components.RsUploader.props.name[​](#componentsrsuploaderpropsname "Direct link to components.RsUploader.props.name")

> **components.RsUploader.props.name**: `object`

#### components.RsUploader.props.name.description[​](#componentsrsuploaderpropsnamedescription "Direct link to components.RsUploader.props.name.description")

> **components.RsUploader.props.name.description**: `string` = `"Upload the parameter name of the corresponding file"`

#### components.RsUploader.props.name.name[​](#componentsrsuploaderpropsnamename "Direct link to components.RsUploader.props.name.name")

> **components.RsUploader.props.name.name**: `string` = `"Name"`

#### components.RsUploader.props.onChange[​](#componentsrsuploaderpropsonchange "Direct link to components.RsUploader.props.onChange")

> **components.RsUploader.props.onChange**: `object`

#### components.RsUploader.props.onChange.description[​](#componentsrsuploaderpropsonchangedescription "Direct link to components.RsUploader.props.onChange.description")

> **components.RsUploader.props.onChange.description**: `string` = `"Callback function that the upload queue has changed"`

#### components.RsUploader.props.onChange.name[​](#componentsrsuploaderpropsonchangename "Direct link to components.RsUploader.props.onChange.name")

> **components.RsUploader.props.onChange.name**: `string` = `"onChange"`

#### components.RsUploader.props.onError[​](#componentsrsuploaderpropsonerror "Direct link to components.RsUploader.props.onError")

> **components.RsUploader.props.onError**: `object`

#### components.RsUploader.props.onError.description[​](#componentsrsuploaderpropsonerrordescription "Direct link to components.RsUploader.props.onError.description")

> **components.RsUploader.props.onError.description**: `string` = `"Upload callback function with error"`

#### components.RsUploader.props.onError.name[​](#componentsrsuploaderpropsonerrorname "Direct link to components.RsUploader.props.onError.name")

> **components.RsUploader.props.onError.name**: `string` = `"onError"`

#### components.RsUploader.props.onPreview[​](#componentsrsuploaderpropsonpreview "Direct link to components.RsUploader.props.onPreview")

> **components.RsUploader.props.onPreview**: `object`

#### components.RsUploader.props.onPreview\.description[​](#componentsrsuploaderpropsonpreviewdescription "Direct link to components.RsUploader.props.onPreview.description")

> **components.RsUploader.props.onPreview\.description**: `string` = `"In the file list, click the callback function for the uploaded file"`

#### components.RsUploader.props.onPreview\.name[​](#componentsrsuploaderpropsonpreviewname "Direct link to components.RsUploader.props.onPreview.name")

> **components.RsUploader.props.onPreview\.name**: `string` = `"onPreview"`

#### components.RsUploader.props.onProgress[​](#componentsrsuploaderpropsonprogress "Direct link to components.RsUploader.props.onProgress")

> **components.RsUploader.props.onProgress**: `object`

#### components.RsUploader.props.onProgress.description[​](#componentsrsuploaderpropsonprogressdescription "Direct link to components.RsUploader.props.onProgress.description")

> **components.RsUploader.props.onProgress.description**: `string` = `"Callback functions that upload progress change"`

#### components.RsUploader.props.onProgress.name[​](#componentsrsuploaderpropsonprogressname "Direct link to components.RsUploader.props.onProgress.name")

> **components.RsUploader.props.onProgress.name**: `string` = `"onProgress"`

#### components.RsUploader.props.onRemove[​](#componentsrsuploaderpropsonremove "Direct link to components.RsUploader.props.onRemove")

> **components.RsUploader.props.onRemove**: `object`

#### components.RsUploader.props.onRemove.description[​](#componentsrsuploaderpropsonremovedescription "Direct link to components.RsUploader.props.onRemove.description")

> **components.RsUploader.props.onRemove.description**: `string` = `"In the file list, click the callback function to delete a file"`

#### components.RsUploader.props.onRemove.name[​](#componentsrsuploaderpropsonremovename "Direct link to components.RsUploader.props.onRemove.name")

> **components.RsUploader.props.onRemove.name**: `string` = `"onRemove"`

#### components.RsUploader.props.onReupload[​](#componentsrsuploaderpropsonreupload "Direct link to components.RsUploader.props.onReupload")

> **components.RsUploader.props.onReupload**: `object`

#### components.RsUploader.props.onReupload.description[​](#componentsrsuploaderpropsonreuploaddescription "Direct link to components.RsUploader.props.onReupload.description")

> **components.RsUploader.props.onReupload.description**: `string` = `"In the file list, for uploading failed files, click the callback function to upload"`

#### components.RsUploader.props.onReupload.name[​](#componentsrsuploaderpropsonreuploadname "Direct link to components.RsUploader.props.onReupload.name")

> **components.RsUploader.props.onReupload.name**: `string` = `"onReupload"`

#### components.RsUploader.props.onSuccess[​](#componentsrsuploaderpropsonsuccess "Direct link to components.RsUploader.props.onSuccess")

> **components.RsUploader.props.onSuccess**: `object`

#### components.RsUploader.props.onSuccess.description[​](#componentsrsuploaderpropsonsuccessdescription "Direct link to components.RsUploader.props.onSuccess.description")

> **components.RsUploader.props.onSuccess.description**: `string` = `"Callback function after successful upload"`

#### components.RsUploader.props.onSuccess.name[​](#componentsrsuploaderpropsonsuccessname "Direct link to components.RsUploader.props.onSuccess.name")

> **components.RsUploader.props.onSuccess.name**: `string` = `"onSuccess"`

#### components.RsUploader.props.onUpload[​](#componentsrsuploaderpropsonupload "Direct link to components.RsUploader.props.onUpload")

> **components.RsUploader.props.onUpload**: `object`

#### components.RsUploader.props.onUpload.description[​](#componentsrsuploaderpropsonuploaddescription "Direct link to components.RsUploader.props.onUpload.description")

> **components.RsUploader.props.onUpload.description**: `string` = `"The callback function that starts the upload file"`

#### components.RsUploader.props.onUpload.name[​](#componentsrsuploaderpropsonuploadname "Direct link to components.RsUploader.props.onUpload.name")

> **components.RsUploader.props.onUpload.name**: `string` = `"onUpload"`

#### components.RsUploader.props.removable[​](#componentsrsuploaderpropsremovable "Direct link to components.RsUploader.props.removable")

> **components.RsUploader.props.removable**: `object`

#### components.RsUploader.props.removable.description[​](#componentsrsuploaderpropsremovabledescription "Direct link to components.RsUploader.props.removable.description")

> **components.RsUploader.props.removable.description**: `string` = `"Removable list file"`

#### components.RsUploader.props.removable.name[​](#componentsrsuploaderpropsremovablename "Direct link to components.RsUploader.props.removable.name")

> **components.RsUploader.props.removable.name**: `string` = `"Removable"`

#### components.RsUploader.props.timeout[​](#componentsrsuploaderpropstimeout "Direct link to components.RsUploader.props.timeout")

> **components.RsUploader.props.timeout**: `object`

#### components.RsUploader.props.timeout.description[​](#componentsrsuploaderpropstimeoutdescription "Direct link to components.RsUploader.props.timeout.description")

> **components.RsUploader.props.timeout.description**: `string` = `"Set upload timeout"`

#### components.RsUploader.props.timeout.name[​](#componentsrsuploaderpropstimeoutname "Direct link to components.RsUploader.props.timeout.name")

> **components.RsUploader.props.timeout.name**: `string` = `"Timeout"`

#### components.RsUploader.props.withCredentials[​](#componentsrsuploaderpropswithcredentials "Direct link to components.RsUploader.props.withCredentials")

> **components.RsUploader.props.withCredentials**: `object`

#### components.RsUploader.props.withCredentials.description[​](#componentsrsuploaderpropswithcredentialsdescription "Direct link to components.RsUploader.props.withCredentials.description")

> **components.RsUploader.props.withCredentials.description**: `string` = `"Whether to carry cookies when uploading requests"`

#### components.RsUploader.props.withCredentials.name[​](#componentsrsuploaderpropswithcredentialsname "Direct link to components.RsUploader.props.withCredentials.name")

> **components.RsUploader.props.withCredentials.name**: `string` = `"With credentials"`

#### components.RsWizard[​](#componentsrswizard "Direct link to components.RsWizard")

> **components.RsWizard**: `object`

#### components.RsWizard.description[​](#componentsrswizarddescription "Direct link to components.RsWizard.description")

> **components.RsWizard.description**: `string` = `"Wizard component with step navigation and validation"`

#### components.RsWizard.name[​](#componentsrswizardname "Direct link to components.RsWizard.name")

> **components.RsWizard.name**: `string` = `"Wizard"`

#### components.RsWizard.props[​](#componentsrswizardprops "Direct link to components.RsWizard.props")

> **components.RsWizard.props**: `object`

#### components.RsWizard.props.activeIndex[​](#componentsrswizardpropsactiveindex "Direct link to components.RsWizard.props.activeIndex")

> **components.RsWizard.props.activeIndex**: `object`

#### components.RsWizard.props.activeIndex.description[​](#componentsrswizardpropsactiveindexdescription "Direct link to components.RsWizard.props.activeIndex.description")

> **components.RsWizard.props.activeIndex.description**: `string` = `"The active step index"`

#### components.RsWizard.props.activeIndex.name[​](#componentsrswizardpropsactiveindexname "Direct link to components.RsWizard.props.activeIndex.name")

> **components.RsWizard.props.activeIndex.name**: `string` = `"Active index"`

#### components.RsWizard.props.children[​](#componentsrswizardpropschildren "Direct link to components.RsWizard.props.children")

> **components.RsWizard.props.children**: `object`

#### components.RsWizard.props.children.description[​](#componentsrswizardpropschildrendescription "Direct link to components.RsWizard.props.children.description")

> **components.RsWizard.props.children.description**: `string` = `"The wizard children"`

#### components.RsWizard.props.children.name[​](#componentsrswizardpropschildrenname "Direct link to components.RsWizard.props.children.name")

> **components.RsWizard.props.children.name**: `string` = `"Children"`

#### components.RsWizard.props.finishButtonLabel[​](#componentsrswizardpropsfinishbuttonlabel "Direct link to components.RsWizard.props.finishButtonLabel")

> **components.RsWizard.props.finishButtonLabel**: `object`

#### components.RsWizard.props.finishButtonLabel.description[​](#componentsrswizardpropsfinishbuttonlabeldescription "Direct link to components.RsWizard.props.finishButtonLabel.description")

> **components.RsWizard.props.finishButtonLabel.description**: `string` = `"The finish button label"`

#### components.RsWizard.props.finishButtonLabel.name[​](#componentsrswizardpropsfinishbuttonlabelname "Direct link to components.RsWizard.props.finishButtonLabel.name")

> **components.RsWizard.props.finishButtonLabel.name**: `string` = `"Finish button label"`

#### components.RsWizard.props.nextButtonLabel[​](#componentsrswizardpropsnextbuttonlabel "Direct link to components.RsWizard.props.nextButtonLabel")

> **components.RsWizard.props.nextButtonLabel**: `object`

#### components.RsWizard.props.nextButtonLabel.description[​](#componentsrswizardpropsnextbuttonlabeldescription "Direct link to components.RsWizard.props.nextButtonLabel.description")

> **components.RsWizard.props.nextButtonLabel.description**: `string` = `"The next button label"`

#### components.RsWizard.props.nextButtonLabel.name[​](#componentsrswizardpropsnextbuttonlabelname "Direct link to components.RsWizard.props.nextButtonLabel.name")

> **components.RsWizard.props.nextButtonLabel.name**: `string` = `"Next button label"`

#### components.RsWizard.props.onFinish[​](#componentsrswizardpropsonfinish "Direct link to components.RsWizard.props.onFinish")

> **components.RsWizard.props.onFinish**: `object`

#### components.RsWizard.props.onFinish.description[​](#componentsrswizardpropsonfinishdescription "Direct link to components.RsWizard.props.onFinish.description")

> **components.RsWizard.props.onFinish.description**: `string` = `"Callback when finish button is clicked"`

#### components.RsWizard.props.onFinish.name[​](#componentsrswizardpropsonfinishname "Direct link to components.RsWizard.props.onFinish.name")

> **components.RsWizard.props.onFinish.name**: `string` = `"onFinish"`

#### components.RsWizard.props.onNext[​](#componentsrswizardpropsonnext "Direct link to components.RsWizard.props.onNext")

> **components.RsWizard.props.onNext**: `object`

#### components.RsWizard.props.onNext.description[​](#componentsrswizardpropsonnextdescription "Direct link to components.RsWizard.props.onNext.description")

> **components.RsWizard.props.onNext.description**: `string` = `"Callback when next button is clicked"`

#### components.RsWizard.props.onNext.name[​](#componentsrswizardpropsonnextname "Direct link to components.RsWizard.props.onNext.name")

> **components.RsWizard.props.onNext.name**: `string` = `"onNext"`

#### components.RsWizard.props.onPrev[​](#componentsrswizardpropsonprev "Direct link to components.RsWizard.props.onPrev")

> **components.RsWizard.props.onPrev**: `object`

#### components.RsWizard.props.onPrev.description[​](#componentsrswizardpropsonprevdescription "Direct link to components.RsWizard.props.onPrev.description")

> **components.RsWizard.props.onPrev.description**: `string` = `"Callback when previous button is clicked"`

#### components.RsWizard.props.onPrev.name[​](#componentsrswizardpropsonprevname "Direct link to components.RsWizard.props.onPrev.name")

> **components.RsWizard.props.onPrev.name**: `string` = `"onPrev"`

#### components.RsWizard.props.prevButtonLabel[​](#componentsrswizardpropsprevbuttonlabel "Direct link to components.RsWizard.props.prevButtonLabel")

> **components.RsWizard.props.prevButtonLabel**: `object`

#### components.RsWizard.props.prevButtonLabel.description[​](#componentsrswizardpropsprevbuttonlabeldescription "Direct link to components.RsWizard.props.prevButtonLabel.description")

> **components.RsWizard.props.prevButtonLabel.description**: `string` = `"The previous button label"`

#### components.RsWizard.props.prevButtonLabel.name[​](#componentsrswizardpropsprevbuttonlabelname "Direct link to components.RsWizard.props.prevButtonLabel.name")

> **components.RsWizard.props.prevButtonLabel.name**: `string` = `"Previous button label"`

#### components.RsWizard.props.showSteps[​](#componentsrswizardpropsshowsteps "Direct link to components.RsWizard.props.showSteps")

> **components.RsWizard.props.showSteps**: `object`

#### components.RsWizard.props.showSteps.description[​](#componentsrswizardpropsshowstepsdescription "Direct link to components.RsWizard.props.showSteps.description")

> **components.RsWizard.props.showSteps.description**: `string` = `"If true, the steps will be shown"`

#### components.RsWizard.props.showSteps.name[​](#componentsrswizardpropsshowstepsname "Direct link to components.RsWizard.props.showSteps.name")

> **components.RsWizard.props.showSteps.name**: `string` = `"Show steps"`

#### components.RsWizard.props.showStepsLabels[​](#componentsrswizardpropsshowstepslabels "Direct link to components.RsWizard.props.showStepsLabels")

> **components.RsWizard.props.showStepsLabels**: `object`

#### components.RsWizard.props.showStepsLabels.description[​](#componentsrswizardpropsshowstepslabelsdescription "Direct link to components.RsWizard.props.showStepsLabels.description")

> **components.RsWizard.props.showStepsLabels.description**: `string` = `"If true, the steps labels will be shown"`

#### components.RsWizard.props.showStepsLabels.name[​](#componentsrswizardpropsshowstepslabelsname "Direct link to components.RsWizard.props.showStepsLabels.name")

> **components.RsWizard.props.showStepsLabels.name**: `string` = `"Show steps labels"`

#### components.RsWizard.props.steps[​](#componentsrswizardpropssteps "Direct link to components.RsWizard.props.steps")

> **components.RsWizard.props.steps**: `object`

#### components.RsWizard.props.steps.description[​](#componentsrswizardpropsstepsdescription "Direct link to components.RsWizard.props.steps.description")

> **components.RsWizard.props.steps.description**: `string` = `"The wizard steps"`

#### components.RsWizard.props.steps.name[​](#componentsrswizardpropsstepsname "Direct link to components.RsWizard.props.steps.name")

> **components.RsWizard.props.steps.name**: `string` = `"Steps"`

#### components.RsWizard.props.stepsNavigation[​](#componentsrswizardpropsstepsnavigation "Direct link to components.RsWizard.props.stepsNavigation")

> **components.RsWizard.props.stepsNavigation**: `object`

#### components.RsWizard.props.stepsNavigation.description[​](#componentsrswizardpropsstepsnavigationdescription "Direct link to components.RsWizard.props.stepsNavigation.description")

> **components.RsWizard.props.stepsNavigation.description**: `string` = `"Determines which steps are available for navigation by clicking"`

#### components.RsWizard.props.stepsNavigation.name[​](#componentsrswizardpropsstepsnavigationname "Direct link to components.RsWizard.props.stepsNavigation.name")

> **components.RsWizard.props.stepsNavigation.name**: `string` = `"Steps navigation"`

#### components.RsWizard.props.validateOnFinish[​](#componentsrswizardpropsvalidateonfinish "Direct link to components.RsWizard.props.validateOnFinish")

> **components.RsWizard.props.validateOnFinish**: `object`

#### components.RsWizard.props.validateOnFinish.description[​](#componentsrswizardpropsvalidateonfinishdescription "Direct link to components.RsWizard.props.validateOnFinish.description")

> **components.RsWizard.props.validateOnFinish.description**: `string` = `"If true, the wizard will be validated before finishing the wizard"`

#### components.RsWizard.props.validateOnFinish.name[​](#componentsrswizardpropsvalidateonfinishname "Direct link to components.RsWizard.props.validateOnFinish.name")

> **components.RsWizard.props.validateOnFinish.name**: `string` = `"Validate on finish"`

#### components.RsWizard.props.validateOnNext[​](#componentsrswizardpropsvalidateonnext "Direct link to components.RsWizard.props.validateOnNext")

> **components.RsWizard.props.validateOnNext**: `object`

#### components.RsWizard.props.validateOnNext.description[​](#componentsrswizardpropsvalidateonnextdescription "Direct link to components.RsWizard.props.validateOnNext.description")

> **components.RsWizard.props.validateOnNext.description**: `string` = `"If true, the step will be validated before moving to the next step"`

#### components.RsWizard.props.validateOnNext.name[​](#componentsrswizardpropsvalidateonnextname "Direct link to components.RsWizard.props.validateOnNext.name")

> **components.RsWizard.props.validateOnNext.name**: `string` = `"Validate on next"`

#### components.RsWizard.props.verticalSteps[​](#componentsrswizardpropsverticalsteps "Direct link to components.RsWizard.props.verticalSteps")

> **components.RsWizard.props.verticalSteps**: `object`

#### components.RsWizard.props.verticalSteps.description[​](#componentsrswizardpropsverticalstepsdescription "Direct link to components.RsWizard.props.verticalSteps.description")

> **components.RsWizard.props.verticalSteps.description**: `string` = `"If true, the steps will be displayed vertically"`

#### components.RsWizard.props.verticalSteps.name[​](#componentsrswizardpropsverticalstepsname "Direct link to components.RsWizard.props.verticalSteps.name")

> **components.RsWizard.props.verticalSteps.name**: `string` = `"Vertical steps"`

#### components.RsWizardStep[​](#componentsrswizardstep "Direct link to components.RsWizardStep")

> **components.RsWizardStep**: `object`

#### components.RsWizardStep.description[​](#componentsrswizardstepdescription "Direct link to components.RsWizardStep.description")

> **components.RsWizardStep.description**: `string` = `"Wizard step component with flex layout"`

#### components.RsWizardStep.name[​](#componentsrswizardstepname "Direct link to components.RsWizardStep.name")

> **components.RsWizardStep.name**: `string` = `"Wizard step"`

#### components.RsWizardStep.props[​](#componentsrswizardstepprops "Direct link to components.RsWizardStep.props")

> **components.RsWizardStep.props**: `object`

#### components.RsWizardStep.props.children[​](#componentsrswizardsteppropschildren "Direct link to components.RsWizardStep.props.children")

> **components.RsWizardStep.props.children**: `object`

#### components.RsWizardStep.props.children.description[​](#componentsrswizardsteppropschildrendescription "Direct link to components.RsWizardStep.props.children.description")

> **components.RsWizardStep.props.children.description**: `string` = `"Component children"`

#### components.RsWizardStep.props.children.name[​](#componentsrswizardsteppropschildrenname "Direct link to components.RsWizardStep.props.children.name")

> **components.RsWizardStep.props.children.name**: `string` = `"Children"`


---

# Variable: rsUploader

> `const` **rsUploader**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsUploaderProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsUploaderProps)>


---

# Variable: rsWizard

> `const` **rsWizard**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RsWizardProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardProps)>


---

# Variable: rsWizardStep

> `const` **rsWizardStep**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`object` & [`RsWizardStepProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardStepProps) & `ClassAttributes`<`HTMLDivElement`> & `HTMLAttributes`<`HTMLDivElement`>>


---

# Variable: view

> `const` **view**: [`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

An assembled set of rSuite components, ready to be passed as a property to the FormViewer.


---

# Variable: viewWithCss

> `const` **viewWithCss**: [`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

An assembled set of rSuite components, ready to be passed as a property to the FormViewer. This view contains CSS loaders.


---

# @react-form-builder/components-signature

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [SignatureProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/interfaces/SignatureProps)

## Variables[​](#variables "Direct link to Variables")

* [signatureComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureComponent)
* [signatureComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureComponentsDescriptions)
* [signatureEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureEnUsComponentsDescriptions)
* [signatureModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/variables/signatureModel)


---

# Interface: SignatureProps

The Signature pad properties.

## Extends[​](#extends "Direct link to Extends")

* `Omit`<`ComponentPropsWithoutRef`<`"canvas"`>, `"width"` | `"height"` | `"onChange"`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Omit.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Omit.accessKey`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Omit.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Omit.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`Omit.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`Omit.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`Omit.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`Omit.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`Omit.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`Omit.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`Omit.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`Omit.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`Omit.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`Omit.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"time"` | `"true"` | `"false"` | `"date"` | `"page"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`Omit.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`Omit.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`Omit.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`Omit.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`Omit.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"execute"` | `"move"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`Omit.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`Omit.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`Omit.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`Omit.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`Omit.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"grid"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`Omit.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`Omit.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`Omit.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`Omit.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`Omit.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`Omit.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`Omit.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`Omit.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`Omit.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`Omit.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`Omit.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`Omit.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`Omit.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`Omit.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`Omit.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`Omit.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`Omit.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"text"` | `"all"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`Omit.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`Omit.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`Omit.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`Omit.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`Omit.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`Omit.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`Omit.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`Omit.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`Omit.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`Omit.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`Omit.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`Omit.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`Omit.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`Omit.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"off"` | `"none"` | `"on"` | `"sentences"` | `"words"` | `"characters"` | `string` & `object`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`Omit.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`Omit.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`Omit.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`Omit.autoSave`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `Fill`

The background color.

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`Omit.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`Omit.className`

***

### clearButtonText?[​](#clearbuttontext "Direct link to clearButtonText?")

> `optional` **clearButtonText**: `string`

Clear button label.

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`Omit.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`Omit.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `Booleanish` | `"inherit"` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`Omit.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`Omit.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`Omit.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`Omit.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`Omit.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`Omit.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`Omit.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`Omit.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"enter"` | `"done"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`Omit.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`Omit.exportparts`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `number`

The canvas height.

#### Default[​](#default "Direct link to Default")

```
150
```

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`Omit.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`Omit.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`Omit.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`Omit.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"text"` | `"none"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`Omit.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`Omit.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`Omit.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`Omit.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`Omit.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`Omit.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`Omit.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`Omit.key`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the component.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`Omit.lang`

***

### lineWidth?[​](#linewidth "Direct link to lineWidth?")

> `optional` **lineWidth**: `number`

The line width.

#### Default[​](#default-1 "Direct link to Default")

```
1.5
```

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`Omit.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`Omit.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`Omit.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`Omit.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`Omit.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`Omit.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`Omit.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`Omit.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`Omit.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`Omit.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`Omit.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`Omit.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`Omit.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`Omit.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`Omit.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`Omit.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`Omit.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`Omit.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`Omit.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`Omit.onCanPlayThroughCapture`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value?`) => `void`

Triggered after stroke update.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value?[​](#value "Direct link to value?")

`string`

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`Omit.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`Omit.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`Omit.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`Omit.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`Omit.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`Omit.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`Omit.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`Omit.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`Omit.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`Omit.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`Omit.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`Omit.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`Omit.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`Omit.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`Omit.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`Omit.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`Omit.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`Omit.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`Omit.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`Omit.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`Omit.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`Omit.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`Omit.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`Omit.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`Omit.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`Omit.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`Omit.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`Omit.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`Omit.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`Omit.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`Omit.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`Omit.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`Omit.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`Omit.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`Omit.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`Omit.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`Omit.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`Omit.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`Omit.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`Omit.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`Omit.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`Omit.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`Omit.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`Omit.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`Omit.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`Omit.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`Omit.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`Omit.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`Omit.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`Omit.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`Omit.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`Omit.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`Omit.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLCanvasElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`Omit.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLCanvasElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`Omit.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`Omit.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`Omit.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`Omit.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`Omit.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`Omit.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`Omit.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`Omit.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`Omit.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`Omit.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`Omit.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`Omit.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`Omit.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`Omit.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`Omit.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`Omit.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`Omit.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`Omit.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`Omit.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`Omit.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`Omit.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`Omit.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`Omit.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`Omit.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`Omit.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`Omit.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`Omit.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`Omit.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`Omit.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`Omit.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`Omit.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`Omit.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`Omit.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`Omit.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`Omit.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`Omit.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`Omit.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`Omit.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`Omit.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`Omit.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`Omit.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`Omit.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`Omit.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`Omit.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`Omit.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`Omit.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`Omit.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`Omit.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`Omit.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`Omit.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`Omit.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`Omit.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`Omit.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`Omit.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`Omit.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`Omit.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`Omit.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`Omit.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`Omit.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`Omit.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`Omit.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`Omit.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`Omit.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`Omit.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`Omit.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`Omit.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`Omit.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`Omit.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`Omit.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`Omit.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`Omit.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`Omit.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`Omit.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`Omit.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`Omit.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`Omit.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`Omit.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`Omit.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`Omit.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`Omit.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`Omit.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`Omit.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`Omit.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`Omit.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`Omit.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`Omit.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`Omit.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`Omit.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`Omit.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`Omit.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`Omit.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`Omit.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`Omit.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLCanvasElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`Omit.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`Omit.part`

***

### penColor?[​](#pencolor "Direct link to penColor?")

> `optional` **penColor**: `Fill`

The pen color.

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"auto"` | `"manual"` | `"hint"`

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`Omit.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`Omit.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`Omit.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`Omit.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`Omit.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`Omit.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Flag, if true - the component is running in read-only mode.

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`Omit.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`Omit.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`Omit.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`Omit.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`Omit.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`Omit.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`Omit.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`Omit.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`Omit.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`Omit.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`Omit.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`Omit.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`Omit.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`Omit.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`Omit.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`Omit.unselectable`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `string`

The initial data URL for drawing the signature image.

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`Omit.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `number`

The canvas width.

#### Default[​](#default-2 "Direct link to Default")

```
300
```


---

# Variable: signatureComponent

> `const` **signatureComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`SignatureProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/interfaces/SignatureProps)> = `signature`


---

# Variable: signatureComponentsDescriptions

> `const` **signatureComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: signatureEnUsComponentsDescriptions

> **signatureEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.fields[​](#categoriesfields "Direct link to categories.fields")

> **categories.fields**: `object`

#### categories.fields.name[​](#categoriesfieldsname "Direct link to categories.fields.name")

> **categories.fields.name**: `string` = `"Fields"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.RsSignature[​](#componentsrssignature "Direct link to components.RsSignature")

> **components.RsSignature**: `object`

#### components.RsSignature.description[​](#componentsrssignaturedescription "Direct link to components.RsSignature.description")

> **components.RsSignature.description**: `string` = `"HTML5 canvas based smooth signature drawing"`

#### components.RsSignature.name[​](#componentsrssignaturename "Direct link to components.RsSignature.name")

> **components.RsSignature.name**: `string` = `"Signature"`

#### components.RsSignature.props[​](#componentsrssignatureprops "Direct link to components.RsSignature.props")

> **components.RsSignature.props**: `object`

#### components.RsSignature.props.backgroundColor[​](#componentsrssignaturepropsbackgroundcolor "Direct link to components.RsSignature.props.backgroundColor")

> **components.RsSignature.props.backgroundColor**: `object`

#### components.RsSignature.props.backgroundColor.description[​](#componentsrssignaturepropsbackgroundcolordescription "Direct link to components.RsSignature.props.backgroundColor.description")

> **components.RsSignature.props.backgroundColor.description**: `string` = `"The background color"`

#### components.RsSignature.props.backgroundColor.name[​](#componentsrssignaturepropsbackgroundcolorname "Direct link to components.RsSignature.props.backgroundColor.name")

> **components.RsSignature.props.backgroundColor.name**: `string` = `"Background color"`

#### components.RsSignature.props.clearButtonText[​](#componentsrssignaturepropsclearbuttontext "Direct link to components.RsSignature.props.clearButtonText")

> **components.RsSignature.props.clearButtonText**: `object`

#### components.RsSignature.props.clearButtonText.description[​](#componentsrssignaturepropsclearbuttontextdescription "Direct link to components.RsSignature.props.clearButtonText.description")

> **components.RsSignature.props.clearButtonText.description**: `string` = `"Clear button label"`

#### components.RsSignature.props.clearButtonText.name[​](#componentsrssignaturepropsclearbuttontextname "Direct link to components.RsSignature.props.clearButtonText.name")

> **components.RsSignature.props.clearButtonText.name**: `string` = `"Clear button text"`

#### components.RsSignature.props.height[​](#componentsrssignaturepropsheight "Direct link to components.RsSignature.props.height")

> **components.RsSignature.props.height**: `object`

#### components.RsSignature.props.height.description[​](#componentsrssignaturepropsheightdescription "Direct link to components.RsSignature.props.height.description")

> **components.RsSignature.props.height.description**: `string` = `"The canvas height"`

#### components.RsSignature.props.height.name[​](#componentsrssignaturepropsheightname "Direct link to components.RsSignature.props.height.name")

> **components.RsSignature.props.height.name**: `string` = `"Height"`

#### components.RsSignature.props.label[​](#componentsrssignaturepropslabel "Direct link to components.RsSignature.props.label")

> **components.RsSignature.props.label**: `object`

#### components.RsSignature.props.label.description[​](#componentsrssignaturepropslabeldescription "Direct link to components.RsSignature.props.label.description")

> **components.RsSignature.props.label.description**: `string` = `"The label for the component"`

#### components.RsSignature.props.label.name[​](#componentsrssignaturepropslabelname "Direct link to components.RsSignature.props.label.name")

> **components.RsSignature.props.label.name**: `string` = `"Label"`

#### components.RsSignature.props.lineWidth[​](#componentsrssignaturepropslinewidth "Direct link to components.RsSignature.props.lineWidth")

> **components.RsSignature.props.lineWidth**: `object`

#### components.RsSignature.props.lineWidth.description[​](#componentsrssignaturepropslinewidthdescription "Direct link to components.RsSignature.props.lineWidth.description")

> **components.RsSignature.props.lineWidth.description**: `string` = `"The line width"`

#### components.RsSignature.props.lineWidth.name[​](#componentsrssignaturepropslinewidthname "Direct link to components.RsSignature.props.lineWidth.name")

> **components.RsSignature.props.lineWidth.name**: `string` = `"Line width"`

#### components.RsSignature.props.penColor[​](#componentsrssignaturepropspencolor "Direct link to components.RsSignature.props.penColor")

> **components.RsSignature.props.penColor**: `object`

#### components.RsSignature.props.penColor.description[​](#componentsrssignaturepropspencolordescription "Direct link to components.RsSignature.props.penColor.description")

> **components.RsSignature.props.penColor.description**: `string` = `"The pen color"`

#### components.RsSignature.props.penColor.name[​](#componentsrssignaturepropspencolorname "Direct link to components.RsSignature.props.penColor.name")

> **components.RsSignature.props.penColor.name**: `string` = `"Pen color"`

#### components.RsSignature.props.readOnly[​](#componentsrssignaturepropsreadonly "Direct link to components.RsSignature.props.readOnly")

> **components.RsSignature.props.readOnly**: `object`

#### components.RsSignature.props.readOnly.description[​](#componentsrssignaturepropsreadonlydescription "Direct link to components.RsSignature.props.readOnly.description")

> **components.RsSignature.props.readOnly.description**: `string` = `"Read-only flag"`

#### components.RsSignature.props.readOnly.name[​](#componentsrssignaturepropsreadonlyname "Direct link to components.RsSignature.props.readOnly.name")

> **components.RsSignature.props.readOnly.name**: `string` = `"Read only"`

#### components.RsSignature.props.value[​](#componentsrssignaturepropsvalue "Direct link to components.RsSignature.props.value")

> **components.RsSignature.props.value**: `object`

#### components.RsSignature.props.value.description[​](#componentsrssignaturepropsvaluedescription "Direct link to components.RsSignature.props.value.description")

> **components.RsSignature.props.value.description**: `string` = `"The initial data URL for drawing the signature image"`

#### components.RsSignature.props.value.name[​](#componentsrssignaturepropsvaluename "Direct link to components.RsSignature.props.value.name")

> **components.RsSignature.props.value.name**: `string` = `"Value"`

#### components.RsSignature.props.width[​](#componentsrssignaturepropswidth "Direct link to components.RsSignature.props.width")

> **components.RsSignature.props.width**: `object`

#### components.RsSignature.props.width.description[​](#componentsrssignaturepropswidthdescription "Direct link to components.RsSignature.props.width.description")

> **components.RsSignature.props.width.description**: `string` = `"The canvas width"`

#### components.RsSignature.props.width.name[​](#componentsrssignaturepropswidthname "Direct link to components.RsSignature.props.width.name")

> **components.RsSignature.props.width.name**: `string` = `"Width"`


---

# Variable: signatureModel

> `const` **signatureModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# @react-form-builder/components-uploader

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [FileType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/FileType)
* [UploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/UploaderProps)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

* [OnError](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/type-aliases/OnError)
* [OnSuccess](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/type-aliases/OnSuccess)

## Variables[​](#variables "Direct link to Variables")

* [uploaderComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderComponent)
* [uploaderComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderComponentsDescriptions)
* [uploaderEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderEnUsComponentsDescriptions)
* [uploaderModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/variables/uploaderModel)


---

# Interface: FileType

Represents a file with upload metadata.

## Properties[​](#properties "Direct link to Properties")

### blobFile?[​](#blobfile "Direct link to blobFile?")

> `optional` **blobFile**: `File`

Source file.

***

### error?[​](#error "Direct link to error?")

> `optional` **error**: `string`

Error message if upload failed.

***

### fileKey?[​](#filekey "Direct link to fileKey?")

> `optional` **fileKey**: `string` | `number`

File unique identifier.

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

File name.

***

### status?[​](#status "Direct link to status?")

> `optional` **status**: `"error"` | `"success"`

Upload status.

***

### url?[​](#url "Direct link to url?")

> `optional` **url**: `string`

The URL of the file that can be previewed.


---

# Interface: UploaderProps

The properties of the Uploader component.

## Extends[​](#extends "Direct link to Extends")

* `DropzoneOptions`.`ComponentProps`<`any`>

## Indexable[​](#indexable "Direct link to Indexable")

\[`key`: `string`]: `any`

## Properties[​](#properties "Direct link to Properties")

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `Accept`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`DropzoneOptions.accept`

***

### action[​](#action "Direct link to action")

> **action**: `string`

URL to upload files to.

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`DropzoneOptions.autoFocus`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the children are in disabled state.

#### Overrides[​](#overrides "Direct link to Overrides")

`DropzoneOptions.disabled`

***

### dropzone?[​](#dropzone "Direct link to dropzone?")

> `optional` **dropzone**: `boolean`

If true, the dropzone will show.

***

### getFilesFromEvent()?[​](#getfilesfromevent "Direct link to getFilesFromEvent()?")

> `optional` **getFilesFromEvent**: (`event`) => `Promise`<(`File` | `DataTransferItem`)\[]>

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`DropEvent`

#### Returns[​](#returns "Direct link to Returns")

`Promise`<(`File` | `DataTransferItem`)\[]>

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`DropzoneOptions.getFilesFromEvent`

***

### maxFiles?[​](#maxfiles "Direct link to maxFiles?")

> `optional` **maxFiles**: `number`

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`DropzoneOptions.maxFiles`

***

### maxSize?[​](#maxsize "Direct link to maxSize?")

> `optional` **maxSize**: `number`

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`DropzoneOptions.maxSize`

***

### minSize?[​](#minsize "Direct link to minSize?")

> `optional` **minSize**: `number`

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`DropzoneOptions.minSize`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`DropzoneOptions.multiple`

***

### noClick?[​](#noclick "Direct link to noClick?")

> `optional` **noClick**: `boolean`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`DropzoneOptions.noClick`

***

### noDrag?[​](#nodrag "Direct link to noDrag?")

> `optional` **noDrag**: `boolean`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`DropzoneOptions.noDrag`

***

### noDragEventsBubbling?[​](#nodrageventsbubbling "Direct link to noDragEventsBubbling?")

> `optional` **noDragEventsBubbling**: `boolean`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`DropzoneOptions.noDragEventsBubbling`

***

### noKeyboard?[​](#nokeyboard "Direct link to noKeyboard?")

> `optional` **noKeyboard**: `boolean`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`DropzoneOptions.noKeyboard`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: [`OnSuccess`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/type-aliases/OnSuccess)

Callback function called when files are successfully uploaded.

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`DropzoneOptions.onDragEnter`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`DropzoneOptions.onDragLeave`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`DropzoneOptions.onDragOver`

***

### onDrop()?[​](#ondrop "Direct link to onDrop()?")

> `optional` **onDrop**: <`T`>(`acceptedFiles`, `fileRejections`, `event`) => `void`

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

##### T[​](#t "Direct link to T")

`T` *extends* `File`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### acceptedFiles[​](#acceptedfiles "Direct link to acceptedFiles")

`T`\[]

##### fileRejections[​](#filerejections "Direct link to fileRejections")

`FileRejection`\[]

##### event[​](#event-1 "Direct link to event")

`DropEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`DropzoneOptions.onDrop`

***

### onDropAccepted()?[​](#ondropaccepted "Direct link to onDropAccepted()?")

> `optional` **onDropAccepted**: <`T`>(`files`, `event`) => `void`

#### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")

##### T[​](#t-1 "Direct link to T")

`T` *extends* `File`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### files[​](#files "Direct link to files")

`T`\[]

##### event[​](#event-2 "Direct link to event")

`DropEvent`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`DropzoneOptions.onDropAccepted`

***

### onDropRejected()?[​](#ondroprejected "Direct link to onDropRejected()?")

> `optional` **onDropRejected**: (`fileRejections`, `event`) => `void`

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### fileRejections[​](#filerejections-1 "Direct link to fileRejections")

`FileRejection`\[]

##### event[​](#event-3 "Direct link to event")

`DropEvent`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`DropzoneOptions.onDropRejected`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: [`OnError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/type-aliases/OnError)

Callback function called when an error occurs during upload.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`DropzoneOptions.onError`

***

### onFileDialogCancel()?[​](#onfiledialogcancel "Direct link to onFileDialogCancel()?")

> `optional` **onFileDialogCancel**: () => `void`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`DropzoneOptions.onFileDialogCancel`

***

### onFileDialogOpen()?[​](#onfiledialogopen "Direct link to onFileDialogOpen()?")

> `optional` **onFileDialogOpen**: () => `void`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`DropzoneOptions.onFileDialogOpen`

***

### preventDropOnDocument?[​](#preventdropondocument "Direct link to preventDropOnDocument?")

> `optional` **preventDropOnDocument**: `boolean`

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`DropzoneOptions.preventDropOnDocument`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the children are in read-only state.

***

### useFsAccessApi?[​](#usefsaccessapi "Direct link to useFsAccessApi?")

> `optional` **useFsAccessApi**: `boolean`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`DropzoneOptions.useFsAccessApi`

***

### validator()?[​](#validator "Direct link to validator()?")

> `optional` **validator**: <`T`>(`file`) => `null` | `FileError` | readonly `FileError`\[]

#### Type Parameters[​](#type-parameters-2 "Direct link to Type Parameters")

##### T[​](#t-2 "Direct link to T")

`T` *extends* `File`

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### file[​](#file "Direct link to file")

`T`

#### Returns[​](#returns-6 "Direct link to Returns")

`null` | `FileError` | readonly `FileError`\[]

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`DropzoneOptions.validator`

***

### value[​](#value "Direct link to value")

> **value**: [`FileType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/FileType)\[]

Current value of the uploader (array of uploaded files).


---

# Type Alias: OnError()

> **OnError** = (`error`, `files?`) => `void`

Callback function called when an error occurs during upload.

## Parameters[​](#parameters "Direct link to Parameters")

### error[​](#error "Direct link to error")

`unknown`

### files?[​](#files "Direct link to files?")

[`FileType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/FileType)\[]

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Type Alias: OnSuccess()

> **OnSuccess** = (`files`) => `void`

Callback function called when files are successfully uploaded.

## Parameters[​](#parameters "Direct link to Parameters")

### files[​](#files "Direct link to files")

[`FileType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/FileType)\[]

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Variable: uploaderComponent

> `const` **uploaderComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`UploaderProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-uploader/interfaces/UploaderProps)> = `uploader`


---

# Variable: uploaderComponentsDescriptions

> `const` **uploaderComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: uploaderEnUsComponentsDescriptions

> **uploaderEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.fields[​](#categoriesfields "Direct link to categories.fields")

> **categories.fields**: `object`

#### categories.fields.name[​](#categoriesfieldsname "Direct link to categories.fields.name")

> **categories.fields.name**: `string` = `"Fields"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.Uploader[​](#componentsuploader "Direct link to components.Uploader")

> **components.Uploader**: `object`

#### components.Uploader.description[​](#componentsuploaderdescription "Direct link to components.Uploader.description")

> **components.Uploader.description**: `string` = `"File upload component with drag and drop support"`

#### components.Uploader.name[​](#componentsuploadername "Direct link to components.Uploader.name")

> **components.Uploader.name**: `string` = `"File uploader"`

#### components.Uploader.props[​](#componentsuploaderprops "Direct link to components.Uploader.props")

> **components.Uploader.props**: `object`

#### components.Uploader.props.accept[​](#componentsuploaderpropsaccept "Direct link to components.Uploader.props.accept")

> **components.Uploader.props.accept**: `object`

#### components.Uploader.props.accept.description[​](#componentsuploaderpropsacceptdescription "Direct link to components.Uploader.props.accept.description")

> **components.Uploader.props.accept.description**: `string` = `"Accepted file types (e.g., image/*, .pdf, .docx)"`

#### components.Uploader.props.accept.name[​](#componentsuploaderpropsacceptname "Direct link to components.Uploader.props.accept.name")

> **components.Uploader.props.accept.name**: `string` = `"Accept"`

#### components.Uploader.props.action[​](#componentsuploaderpropsaction "Direct link to components.Uploader.props.action")

> **components.Uploader.props.action**: `object`

#### components.Uploader.props.action.description[​](#componentsuploaderpropsactiondescription "Direct link to components.Uploader.props.action.description")

> **components.Uploader.props.action.description**: `string` = `"URL to upload files to"`

#### components.Uploader.props.action.name[​](#componentsuploaderpropsactionname "Direct link to components.Uploader.props.action.name")

> **components.Uploader.props.action.name**: `string` = `"Action URL"`

#### components.Uploader.props.children[​](#componentsuploaderpropschildren "Direct link to components.Uploader.props.children")

> **components.Uploader.props.children**: `object`

#### components.Uploader.props.children.description[​](#componentsuploaderpropschildrendescription "Direct link to components.Uploader.props.children.description")

> **components.Uploader.props.children.description**: `string` = `"Content to display inside the uploader"`

#### components.Uploader.props.children.name[​](#componentsuploaderpropschildrenname "Direct link to components.Uploader.props.children.name")

> **components.Uploader.props.children.name**: `string` = `"Children"`

#### components.Uploader.props.disabled[​](#componentsuploaderpropsdisabled "Direct link to components.Uploader.props.disabled")

> **components.Uploader.props.disabled**: `object`

#### components.Uploader.props.disabled.description[​](#componentsuploaderpropsdisableddescription "Direct link to components.Uploader.props.disabled.description")

> **components.Uploader.props.disabled.description**: `string` = `"If true, the children are in disabled state"`

#### components.Uploader.props.disabled.name[​](#componentsuploaderpropsdisabledname "Direct link to components.Uploader.props.disabled.name")

> **components.Uploader.props.disabled.name**: `string` = `"Disabled"`

#### components.Uploader.props.dropzone[​](#componentsuploaderpropsdropzone "Direct link to components.Uploader.props.dropzone")

> **components.Uploader.props.dropzone**: `object`

#### components.Uploader.props.dropzone.description[​](#componentsuploaderpropsdropzonedescription "Direct link to components.Uploader.props.dropzone.description")

> **components.Uploader.props.dropzone.description**: `string` = `"If true, the dropzone will show"`

#### components.Uploader.props.dropzone.name[​](#componentsuploaderpropsdropzonename "Direct link to components.Uploader.props.dropzone.name")

> **components.Uploader.props.dropzone.name**: `string` = `"Dropzone"`

#### components.Uploader.props.multiple[​](#componentsuploaderpropsmultiple "Direct link to components.Uploader.props.multiple")

> **components.Uploader.props.multiple**: `object`

#### components.Uploader.props.multiple.description[​](#componentsuploaderpropsmultipledescription "Direct link to components.Uploader.props.multiple.description")

> **components.Uploader.props.multiple.description**: `string` = `"Allow multiple file selection"`

#### components.Uploader.props.multiple.name[​](#componentsuploaderpropsmultiplename "Direct link to components.Uploader.props.multiple.name")

> **components.Uploader.props.multiple.name**: `string` = `"Multiple files"`

#### components.Uploader.props.onChange[​](#componentsuploaderpropsonchange "Direct link to components.Uploader.props.onChange")

> **components.Uploader.props.onChange**: `object`

#### components.Uploader.props.onChange.description[​](#componentsuploaderpropsonchangedescription "Direct link to components.Uploader.props.onChange.description")

> **components.Uploader.props.onChange.description**: `string` = `"Callback when files are successfully uploaded"`

#### components.Uploader.props.onChange.name[​](#componentsuploaderpropsonchangename "Direct link to components.Uploader.props.onChange.name")

> **components.Uploader.props.onChange.name**: `string` = `"On Change"`

#### components.Uploader.props.onError[​](#componentsuploaderpropsonerror "Direct link to components.Uploader.props.onError")

> **components.Uploader.props.onError**: `object`

#### components.Uploader.props.onError.description[​](#componentsuploaderpropsonerrordescription "Direct link to components.Uploader.props.onError.description")

> **components.Uploader.props.onError.description**: `string` = `"Callback when an error occurs during upload"`

#### components.Uploader.props.onError.name[​](#componentsuploaderpropsonerrorname "Direct link to components.Uploader.props.onError.name")

> **components.Uploader.props.onError.name**: `string` = `"On Error"`

#### components.Uploader.props.readOnly[​](#componentsuploaderpropsreadonly "Direct link to components.Uploader.props.readOnly")

> **components.Uploader.props.readOnly**: `object`

#### components.Uploader.props.readOnly.description[​](#componentsuploaderpropsreadonlydescription "Direct link to components.Uploader.props.readOnly.description")

> **components.Uploader.props.readOnly.description**: `string` = `"If true, the children are in read-only state"`

#### components.Uploader.props.readOnly.name[​](#componentsuploaderpropsreadonlyname "Direct link to components.Uploader.props.readOnly.name")

> **components.Uploader.props.readOnly.name**: `string` = `"Read Only"`


---

# Variable: uploaderModel

> `const` **uploaderModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# @react-form-builder/core

## Enumerations[​](#enumerations "Direct link to Enumerations")

* [BiDi](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi)
* [PersistedFormVersion](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/PersistedFormVersion)

## Classes[​](#classes "Direct link to Classes")

* [ActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)
* [ActionEventArgs](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionEventArgs)
* [Annotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)
* [AnnotationBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)
* [ArrayBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder)
* [BaseBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder)
* [BuilderOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)
* [BuilderView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView)
* [CalculableResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/CalculableResult)
* [ComponentData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)
* [ComponentDataEvents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentDataEvents)
* [ComponentKeyChangedEventArgs](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentKeyChangedEventArgs)
* [ComponentState](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentState)
* [ComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)
* [ContainerAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ContainerAnnotation)
* [DataValidator](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/DataValidator)
* [EventAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/EventAnnotation)
* [FluentLocalizationEngine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/FluentLocalizationEngine)
* [Form](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Form)
* [FormViewerPropsStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/FormViewerPropsStore)
* [Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)
* [LocalizationStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/LocalizationStore)
* [Meta](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta)
* [Model](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)
* [ModuleAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ModuleAnnotation)
* [NodeAnnotationBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder)
* [NoopLocalizationEngine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NoopLocalizationEngine)
* [OneOfBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)
* [PropertyAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/PropertyAnnotation)
* [QuantifierBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)
* [SomeOfBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)
* [Store](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)
* [StyleAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/StyleAnnotation)
* [SyncEvent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SyncEvent)
* [TemplateField](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TemplateField)
* [TypedBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)
* [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [BaseCompilationResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BaseCompilationResult)
* [BuilderComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)
* [ComponentField](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentField)
* [ComponentMetadataEventListeners](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners)
* [ComponentProperty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)
* [ComponentTreeProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentTreeProps)
* [Definer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)
* [EmbeddedFormProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/EmbeddedFormProps)
* [ErrorWrapperProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)
* [Field](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)
* [FormViewerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps)
* [FormViewerWrapperComponentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerWrapperComponentProps)
* [IComponentBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)
* [IComponentDataFactory](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentDataFactory)
* [IComponentState](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState)
* [IDataRootProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IDataRootProvider)
* [IEventHandlerBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder)
* [IForm](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm)
* [IFormData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)
* [IFormJsonBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)
* [IFormViewer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer)
* [ILocalizationEngine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine)
* [ILocalizationStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationStore)
* [InternalErrorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/InternalErrorProps)
* [IStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)
* [IValidationBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder)
* [IView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView)
* [LabeledValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue)
* [LocalizationError](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)
* [PersistedForm](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/PersistedForm)
* [ScreenProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ScreenProps)
* [SuppressResizeObserverErrorsProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/SuppressResizeObserverErrorsProps)
* [WrapperProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

* [ActionData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData)
* [ActionEventHandler](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler)
* [ActionHandler](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionHandler)
* [ActionParameters](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters)
* [ActionsInitializer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionsInitializer)
* [ActionType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionType)
* [ActionValues](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)
* [Annotations](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)
* [AnnotationType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AnnotationType)
* [Arguments](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Arguments)
* [ArgumentValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ArgumentValue)
* [AriaAttributesIds](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesIds)
* [AriaAttributesOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesOptions)
* [BoundValueSchema](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BoundValueSchema)
* [BuilderMode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderMode)
* [BuilderSetup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)
* [BuilderTheme](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderTheme)
* [CellInfo](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CellInfo)
* [ComponentDescription](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDescription)
* [ComponentDeviceStyle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDeviceStyle)
* [ComponentFeature](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeature)
* [ComponentFeatures](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeatures)
* [ComponentKey](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKey)
* [ComponentKind](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKind)
* [ComponentLibraryDescription](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)
* [ComponentLocalizer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLocalizer)
* [ComponentPropertiesContext](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertiesContext)
* [ComponentPropertyBindType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)
* [ComponentPropertyComputeType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyComputeType)
* [ComponentPropertyName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyName)
* [ComponentPropsLocalization](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropsLocalization)
* [ComponentRole](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentRole)
* [ComponentsLocalization](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentsLocalization)
* [ComponentStateFactory](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStateFactory)
* [ComponentStoreLocalizer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStoreLocalizer)
* [ComponentStyle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStyle)
* [ComputeChildren](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComputeChildren)
* [Css](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css)
* [CssLoaderType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CssLoaderType)
* [CssPart](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CssPart)
* [CustomActions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomActions)
* [CustomValidationRules](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRules)
* [CustomValidationRuleSettings](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRuleSettings)
* [DataBindingType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType)
* [DataKeyType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataKeyType)
* [DefineActionHelper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DefineActionHelper)
* [DefinerData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DefinerData)
* [Device](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Device)
* [DeviceStyle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DeviceStyle)
* [EditorType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EditorType)
* [ErrorMap](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)
* [ErrorMessageLocalizer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMessageLocalizer)
* [EventHandler](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventHandler)
* [EventName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventName)
* [FieldType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FieldType)
* [FirstParameter](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FirstParameter)
* [FormBuilderComponentIconName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormBuilderComponentIconName)
* [FormOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormOptions)
* [FormValidator](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidator)
* [FormValidators](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidators)
* [FormViewerValidationRules](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerValidationRules)
* [FormViewerWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)
* [Func](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func)
* [FunctionArgumentValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FunctionArgumentValue)
* [GetInitialDataFn](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/GetInitialDataFn)
* [HtmlAttribute](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/HtmlAttribute)
* [I18nItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/I18nItem)
* [iconsList](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/iconsList)
* [IDisposable](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/IDisposable)
* [InsertRestrictionFn](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn)
* [LanguageFullCode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode)
* [LocalizationType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationType)
* [LocalizationValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue)
* [MessagesMap](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/MessagesMap)
* [ModalComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ModalComponentStore)
* [NamedActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NamedActionDefinition)
* [NodeEditorType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType)
* [ParameterDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterDefinition)
* [ParameterName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterName)
* [ParameterType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterType)
* [PreAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)
* [PrimitiveArgumentValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PrimitiveArgumentValue)
* [PropertyBlockType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PropertyBlockType)
* [PropertyKey](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PropertyKey)
* [ReactProperty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ReactProperty)
* [Rel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Rel)
* [ResolvedValidator](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ResolvedValidator)
* [RuleValidator](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)
* [RuleValidatorResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult)
* [SchemaResolver](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaResolver)
* [SchemaType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaType)
* [SchemaTypeMap](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)
* [SetInitialDataFn](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SetInitialDataFn)
* [Setter](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Setter)
* [SyncEventHandler](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SyncEventHandler)
* [TemplateProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/TemplateProps)
* [TypedLocalization](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/TypedLocalization)
* [ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)
* [ValidationResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult)
* [ValidationRule](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRule)
* [ValidationRuleParameter](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleParameter)
* [ValidationRuleSet](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSet)
* [ValidationRuleSettings](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSettings)
* [ValidatorFactory](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorFactory)
* [Validators](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Validators)
* [ValidatorType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorType)
* [ViewMode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ViewMode)

## Variables[​](#variables "Direct link to Variables")

* [ActionEventArgsDeclaration](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/ActionEventArgsDeclaration)
* [array](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/array)
* [AsyncFunction](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/AsyncFunction)
* [boolean](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/boolean)
* [BuilderModeProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/BuilderModeProvider)
* [BuilderThemeProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/BuilderThemeProvider)
* [CellInfoContextProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/CellInfoContextProvider)
* [cfComponentIsPreset](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfComponentIsPreset)
* [cfDisableActionEditors](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableActionEditors)
* [cfDisableAdditionalProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableAdditionalProperties)
* [cfDisableComponentRemove](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableComponentRemove)
* [cfDisableMainComponentProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableMainComponentProperties)
* [cfDisableStyleProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableStyleProperties)
* [cfDisableStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableStyles)
* [cfDisableStylesForClassNameEditor](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableStylesForClassNameEditor)
* [cfDisableTooltipProperties](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableTooltipProperties)
* [cfDisableWrapperStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfDisableWrapperStyles)
* [cfEnableInlineStylesEditor](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfEnableInlineStylesEditor)
* [cfHideFromComponentPalette](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cfHideFromComponentPalette)
* [className](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/className)
* [color](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/color)
* [commonStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/commonStyles)
* [ComponentDataProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/ComponentDataProvider)
* [containerStyles](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/containerStyles)
* [coreComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/coreComponentsDescriptions)
* [createAnnotation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/createAnnotation)
* [createView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/createView)
* [cssSize](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/cssSize)
* [date](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/date)
* [DefaultWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/DefaultWrapper)
* [define](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/define)
* [definePreset](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/definePreset)
* [DidMountEvent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/DidMountEvent)
* [disabled](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/disabled)
* [embeddedFormMeta](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/embeddedFormMeta)
* [embeddedFormModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/embeddedFormModel)
* [emotionCache](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/emotionCache)
* [emptyComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/emptyComponentStore)
* [errorMessageModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/errorMessageModel)
* [event](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/event)
* [FormViewer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/FormViewer)
* [FormViewerLite](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/FormViewerLite)
* [globalDefaultLanguage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/globalDefaultLanguage)
* [htmlAttributes](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/htmlAttributes)
* [IFormDataDeclaration](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/IFormDataDeclaration)
* [internalErrorModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/internalErrorModel)
* [isUniqueKey](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/isUniqueKey)
* [key](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/key)
* [KeySymbol](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/KeySymbol)
* [node](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/node)
* [nodeArray](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/nodeArray)
* [nonNegNumber](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/nonNegNumber)
* [number](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/number)
* [object](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/object)
* [oneOf](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/oneOf)
* [oneOfStrict](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/oneOfStrict)
* [readOnly](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/readOnly)
* [renderWhen](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/renderWhen)
* [required](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/required)
* [screenModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/screenModel)
* [size](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/size)
* [slotModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/slotModel)
* [someOf](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/someOf)
* [StoreContext](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/StoreContext)
* [StoreProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/StoreProvider)
* [string](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/string)
* [stringNode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/stringNode)
* [time](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/time)
* [timeFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/timeFormat)
* [tooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/tooltipProps)
* [tooltipType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/tooltipType)
* [useBuilderMode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useBuilderMode)
* [useBuilderTheme](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useBuilderTheme)
* [useComponentData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useComponentData)
* [useStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useStore)
* [useViewerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useViewerProps)
* [validation](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/validation)
* [ViewerPropsProvider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/ViewerPropsProvider)
* [WillUnmountEvent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/WillUnmountEvent)

## Functions[​](#functions "Direct link to Functions")

* [buildForm](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/buildForm)
* [calculatePropertyValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/calculatePropertyValue)
* [camelCase](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/camelCase)
* [checkSlotCondition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/checkSlotCondition)
* [cloneDeep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/cloneDeep)
* [ComponentTree](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/ComponentTree)
* [createActionValuesFromObject](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/createActionValuesFromObject)
* [createNonNullableContext](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/createNonNullableContext)
* [createProperty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/createProperty)
* [debounce](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/debounce)
* [findLanguage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/findLanguage)
* [findTreeElementDepth](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/findTreeElementDepth)
* [fn](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/fn)
* [forwardRef](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/forwardRef)
* [generateTemplateTypeName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/generateTemplateTypeName)
* [generateUniqueName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/generateUniqueName)
* [getChildren](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getChildren)
* [getDefault](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getDefault)
* [getDefaultCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getDefaultCss)
* [getEditableFormData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getEditableFormData)
* [getKey](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getKey)
* [getTemplateName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getTemplateName)
* [getValidatorPropertyBlockType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/getValidatorPropertyBlockType)
* [groupBy](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/groupBy)
* [isContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isContainer)
* [isEmpty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isEmpty)
* [isEqual](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isEqual)
* [isEqualWith](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isEqualWith)
* [isFunctionalProperty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isFunctionalProperty)
* [isLocalizedProperty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isLocalizedProperty)
* [isNull](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isNull)
* [isNumber](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isNumber)
* [isObject](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isObject)
* [isPromise](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isPromise)
* [isProperty](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isProperty)
* [isString](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isString)
* [isTemplateType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isTemplateType)
* [isUndefined](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isUndefined)
* [isValidatorPropertyBlockType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/isValidatorPropertyBlockType)
* [loadResource](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/loadResource)
* [merge](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/merge)
* [nameAutorun](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/nameAutorun)
* [namedObserver](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/namedObserver)
* [nameObservable](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/nameObservable)
* [needRender](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/needRender)
* [startCase](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/startCase)
* [SuppressResizeObserverErrors](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/SuppressResizeObserverErrors)
* [toArray](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/toArray)
* [toLabeledValues](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/toLabeledValues)
* [toUpper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/toUpper)
* [treeForEach](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/treeForEach)
* [uniqueId](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/uniqueId)
* [unloadResource](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/unloadResource)
* [upperFirst](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/upperFirst)
* [useAriaAttributes](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaAttributes)
* [useAriaAttributesIds](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaAttributesIds)
* [useAriaErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaErrorMessage)
* [useAriaInvalid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useAriaInvalid)
* [useBuilderComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useBuilderComponent)
* [useBuilderValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useBuilderValue)
* [useDisposable](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useDisposable)
* [useErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useErrorMessage)
* [useErrorModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useErrorModel)
* [useMobxConfig](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useMobxConfig)
* [useModalComponentData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useModalComponentData)
* [useModalType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useModalType)
* [useTooltipType](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/functions/useTooltipType)


---

# Class: ActionDefinition

Represents the definition of an action.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ActionDefinition**(`func`, `body?`, `params?`): `ActionDefinition`

Creates a new instance of the ActionDefinition class.

#### Parameters[​](#parameters "Direct link to Parameters")

##### func[​](#func "Direct link to func")

[`Func`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func)

the function of an action.

##### body?[​](#body "Direct link to body?")

`string`

the source code of the Action.

##### params?[​](#params "Direct link to params?")

[`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

#### Returns[​](#returns "Direct link to Returns")

`ActionDefinition`

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body-1 "Direct link to body?")

> `readonly` `optional` **body**: `string`

the source code of the Action.

***

### func[​](#func-1 "Direct link to func")

> `readonly` **func**: [`Func`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func)

the function of an action.

***

### params[​](#params-1 "Direct link to params")

> `readonly` **params**: [`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

## Methods[​](#methods "Direct link to Methods")

### createFromObject()[​](#createfromobject "Direct link to createFromObject()")

> `static` **createFromObject**(`value`): `ActionDefinition`

Correctly creates the ActionDefinition from deserialized data.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the deserialized data.

#### Returns[​](#returns-1 "Direct link to Returns")

`ActionDefinition`

the ActionDefinition instance.

***

### functionalAction()[​](#functionalaction "Direct link to functionalAction()")

> `static` **functionalAction**(`func`, `params`): `ActionDefinition`

Creates an action from the function.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### func[​](#func-2 "Direct link to func")

[`Func`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func)

the function of an action.

##### params[​](#params-2 "Direct link to params")

[`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

#### Returns[​](#returns-2 "Direct link to Returns")

`ActionDefinition`

the new instance of the ActionDefinition class.

***

### sourceAction()[​](#sourceaction "Direct link to sourceAction()")

> `static` **sourceAction**(`body`, `params`): `ActionDefinition`

Creates an action from the source code.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### body[​](#body-2 "Direct link to body")

`string`

the source code of the Action.

##### params[​](#params-3 "Direct link to params")

[`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

#### Returns[​](#returns-3 "Direct link to Returns")

`ActionDefinition`

the new instance of the ActionDefinition class.


---

# Class: ActionEventArgs

Arguments passed to the event handler.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ActionEventArgs**(`type`, `sender`, `store`, `args`, `renderedProps`, `cellInfo?`): `ActionEventArgs`

Creates arguments for the event handler.

#### Parameters[​](#parameters "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`string`

the event type.

##### sender[​](#sender "Direct link to sender")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the component that triggered the event.

##### store[​](#store "Direct link to store")

[`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)

the form viewer settings.

##### args[​](#args "Direct link to args")

`any`\[]

the event arguments.

##### renderedProps[​](#renderedprops "Direct link to renderedProps")

`Record`<`string`, `any`>

the component properties that were used to render the sender component.

##### cellInfo?[​](#cellinfo "Direct link to cellInfo?")

[`CellInfo`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CellInfo)

the information about the current table cell.

#### Returns[​](#returns "Direct link to Returns")

`ActionEventArgs`

## Properties[​](#properties "Direct link to Properties")

### args[​](#args-1 "Direct link to args")

> `readonly` **args**: `any`\[]

the event arguments.

***

### cellInfo?[​](#cellinfo-1 "Direct link to cellInfo?")

> `readonly` `optional` **cellInfo**: [`CellInfo`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CellInfo)

the information about the current table cell.

***

### index?[​](#index "Direct link to index?")

> `readonly` `optional` **index**: `number`

The index of the component in the array, if the component is in the array.

***

### renderedProps[​](#renderedprops-1 "Direct link to renderedProps")

> `readonly` **renderedProps**: `Record`<`string`, `any`>

the component properties that were used to render the sender component.

***

### sender[​](#sender-1 "Direct link to sender")

> `readonly` **sender**: [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the component that triggered the event.

***

### store[​](#store-1 "Direct link to store")

> `readonly` **store**: [`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)

the form viewer settings.

***

### type[​](#type-1 "Direct link to type")

> `readonly` **type**: `string`

the event type.

## Accessors[​](#accessors "Direct link to Accessors")

### data[​](#data "Direct link to data")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **data**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-1 "Direct link to Returns")

`Record`<`string`, `unknown`>

the object for reading and changing form data.

***

### event[​](#event "Direct link to event")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **event**(): `null` | `SyntheticEvent`<`Element`, `Event`>

##### Returns[​](#returns-2 "Direct link to Returns")

`null` | `SyntheticEvent`<`Element`, `Event`>

the event handled by the event handler.

***

### parentData[​](#parentdata "Direct link to parentData")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **parentData**(): `undefined` | `Record`<`string`, `unknown`>

##### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | `Record`<`string`, `unknown`>

the object to read and modify parent data (available for array elements).

***

### rootData[​](#rootdata "Direct link to rootData")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **rootData**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-4 "Direct link to Returns")

`Record`<`string`, `unknown`>

the object to read and modify root form data.

***

### userDefinedProps[​](#userdefinedprops "Direct link to userDefinedProps")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **userDefinedProps**(): `Record`<`string`, `any`>

##### Returns[​](#returns-5 "Direct link to Returns")

`Record`<`string`, `any`>

user-defined properties for the React component that override other properties of the component.

***

### value[​](#value "Direct link to value")

#### Get Signature[​](#get-signature-5 "Direct link to Get Signature")

> **get** **value**(): `any`

##### Returns[​](#returns-6 "Direct link to Returns")

`any`

the first element of the event argument array, which is treated as a value.

## Methods[​](#methods "Direct link to Methods")

### setUserDefinedProps()[​](#setuserdefinedprops "Direct link to setUserDefinedProps()")

> **setUserDefinedProps**(`props?`): `void`

Sets user-defined properties for the React component that override other properties of the component.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### props?[​](#props "Direct link to props?")

`Record`<`string`, `any`>

the component properties.

#### Returns[​](#returns-7 "Direct link to Returns")

`void`


---

# Class: Annotation

Basic metadata class for a React component property for the form builder.

## Extended by[​](#extended-by "Direct link to Extended by")

* [`PropertyAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/PropertyAnnotation)
* [`ContainerAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ContainerAnnotation)
* [`EventAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/EventAnnotation)
* [`ModuleAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ModuleAnnotation)
* [`StyleAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/StyleAnnotation)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new Annotation**(`key`, `name`): `Annotation`

Creates metadata for a React component property.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the property name.

##### name[​](#name "Direct link to name")

`string`

the human-readable property name.

#### Returns[​](#returns "Direct link to Returns")

`Annotation`

## Properties[​](#properties "Direct link to Properties")

### bindingType?[​](#bindingtype "Direct link to bindingType?")

> `readonly` `optional` **bindingType**: [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)

The component property binding type.

***

### calculable[​](#calculable "Direct link to calculable")

> `readonly` **calculable**: `boolean` = `true`

True if the property value can be a calculated property, false otherwise.

***

### controlsRequiredProp[​](#controlsrequiredprop "Direct link to controlsRequiredProp")

> `readonly` **controlsRequiredProp**: `boolean` = `false`

True if the property value controls a required flag, false otherwise.

***

### dataBindingType[​](#databindingtype "Direct link to dataBindingType")

> `readonly` **dataBindingType**: [`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

The type of component data binding.

***

### default?[​](#default "Direct link to default?")

> `readonly` `optional` **default**: `any`

The default property value.

***

### disabled[​](#disabled "Direct link to disabled")

> `readonly` **disabled**: `boolean` = `false`

True if the property value controls a disabled flag, false otherwise.

***

### editor[​](#editor "Direct link to editor")

> `readonly` **editor**: `string`

The name of the component's property editor.

***

### editorProps?[​](#editorprops "Direct link to editorProps?")

> `readonly` `optional` **editorProps**: `any`

Additional properties for the component property editor.

***

### errorMap?[​](#errormap "Direct link to errorMap?")

> `readonly` `optional` **errorMap**: [`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

Message and/or error code for the validation function.

***

### hint?[​](#hint "Direct link to hint?")

> `readonly` `optional` **hint**: `ReactNode`

The hint for the component property.

***

### key[​](#key-1 "Direct link to key")

> `readonly` **key**: `string`

The component property key.

***

### localizable[​](#localizable "Direct link to localizable")

> `readonly` **localizable**: `boolean` = `false`

True if the property value can be localized, false otherwise.

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

The component property name.

***

### readOnly[​](#readonly "Direct link to readOnly")

> `readonly` **readOnly**: `boolean` = `false`

True if the property value controls a read-only flag, false otherwise.

***

### required[​](#required "Direct link to required")

> `readonly` **required**: `boolean` = `false`

True if the component property is required, false otherwise.

***

### slotConditionBuilder()?[​](#slotconditionbuilder "Direct link to slotConditionBuilder()?")

> `readonly` `optional` **slotConditionBuilder**: (`props`) => `string`

A function that returns a string containing the source code of the function to bind child components.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the properties of the component, which are available only inside Form Builder Designer.

#### Returns[​](#returns-1 "Direct link to Returns")

`string`

***

### type?[​](#type "Direct link to type?")

> `readonly` `optional` **type**: keyof SchemaTypeMap

The data type for the value of the property.

***

### uncontrolledValue?[​](#uncontrolledvalue "Direct link to uncontrolledValue?")

> `readonly` `optional` **uncontrolledValue**: `unknown`

The property value for the uncontrolled state.

***

### validator?[​](#validator "Direct link to validator?")

> `readonly` `optional` **validator**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The function for validating the property value.

***

### valued[​](#valued "Direct link to valued")

> `readonly` **valued**: `boolean` = `false`

True if the property value is bound to form data, false otherwise.

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `any`

#### Returns[​](#returns-2 "Direct link to Returns")

`any`

the metadata clone.


---

# Class: AnnotationBuilder\<T>

The builder class to define the metadata property of the form builder component.

## Extends[​](#extends "Direct link to Extends")

* [`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder)<`T`>

## Extended by[​](#extended-by "Direct link to Extended by")

* [`NodeAnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder)

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new AnnotationBuilder**<`T`>(`editor`): `AnnotationBuilder`<`T`>

Creates a component property metadata builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### editor[​](#editor "Direct link to editor")

`string`

the property editor type.

#### Returns[​](#returns "Direct link to Returns")

`AnnotationBuilder`<`T`>

#### Overrides[​](#overrides "Direct link to Overrides")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#constructor)

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#annotation)

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`options`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#options)

## Accessors[​](#accessors "Direct link to Accessors")

### array[​](#array "Direct link to array")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **array**(): [`ArrayBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder)<`undefined` | `T`\[]>

Sets the property as a "array" property.

##### Returns[​](#returns-1 "Direct link to Returns")

[`ArrayBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder)<`undefined` | `T`\[]>

the instance of the metadata property builder.

***

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-2 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`dataBound`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#databound)

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the component property that can be localized.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`localize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#localize)

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-4 "Direct link to Returns")

`this`

the non-localizable component property.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`notLocalize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#notlocalize)

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-5 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#valued)

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-6 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`build`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#build)

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `AnnotationBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-7 "Direct link to Returns")

`AnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#calculable)

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-8 "Direct link to Returns")

`this`

the cloned instance of the builder.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#clone)

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-9 "Direct link to Returns")

`string`

the annotation name.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`getName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#getname)

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-10 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`hideEditor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#hideeditor)

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `AnnotationBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-11 "Direct link to Returns")

`AnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`hinted`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#hinted)

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `AnnotationBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-12 "Direct link to Returns")

`AnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`named`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#named)

***

### oneOf()[​](#oneof "Direct link to oneOf()")

> **oneOf**<`U`>(...`values`): [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

Sets the property as a "single select" property.

#### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")

##### U[​](#u "Direct link to U")

`U` *extends* `string` | `number`

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### values[​](#values "Direct link to values")

...`U`\[]

the possible values for the property.

#### Returns[​](#returns-13 "Direct link to Returns")

[`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

the instance of the metadata property builder.

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-14 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`setup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#setup)

***

### someOf()[​](#someof "Direct link to someOf()")

> **someOf**<`U`>(...`values`): [`SomeOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)<`U`>

Sets the property as a "multiple select" property.

#### Type Parameters[​](#type-parameters-2 "Direct link to Type Parameters")

##### U[​](#u-1 "Direct link to U")

`U` *extends* `string` | `number`

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### values[​](#values-1 "Direct link to values")

...`U`\[]

the possible values for the property.

#### Returns[​](#returns-15 "Direct link to Returns")

[`SomeOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)<`U`>

the instance of the metadata property builder.

***

### typed()[​](#typed "Direct link to typed()")

> **typed**<`T`>(`type`): [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)\[`T`]>

Sets the field type for the component property.

#### Type Parameters[​](#type-parameters-3 "Direct link to Type Parameters")

##### T[​](#t-1 "Direct link to T")

`T` *extends* keyof [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`T`

the field type.

#### Returns[​](#returns-16 "Direct link to Returns")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)\[`T`]>

the instance of the metadata property builder.

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `AnnotationBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-17 "Direct link to Returns")

`AnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#uncontrolledvalue)

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-18 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`withEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#witheditorprops)

***

### create()[​](#create "Direct link to create()")

> `static` **create**<`T`>(`editor`): `AnnotationBuilder`<`T`>

Creates a component property metadata builder.

#### Type Parameters[​](#type-parameters-4 "Direct link to Type Parameters")

##### T[​](#t-2 "Direct link to T")

`T`

the property type.

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### editor[​](#editor-1 "Direct link to editor")

`string`

the property editor type.

#### Returns[​](#returns-19 "Direct link to Returns")

`AnnotationBuilder`<`T`>

the component property metadata builder.


---

# Class: ArrayBuilder\<T>

The builder class to define the metadata property of the form builder component. Used for properties where the property value is an array.

## Extends[​](#extends "Direct link to Extends")

* [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`T`>

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ArrayBuilder**<`T`>(): `ArrayBuilder`<`T`>

#### Returns[​](#returns "Direct link to Returns")

`ArrayBuilder`<`T`>

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#constructor)

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#annotation)

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`options`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#options)

***

### subType?[​](#subtype "Direct link to subType?")

> `optional` **subType**: keyof SchemaTypeMap

## Accessors[​](#accessors "Direct link to Accessors")

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-1 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`dataBound`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#databound)

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-2 "Direct link to Returns")

`this`

the component property that can be localized.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`localize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#localize)

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the non-localizable component property.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`notLocalize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#notlocalize)

***

### ofObject[​](#ofobject "Direct link to ofObject")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **ofObject**(): `ArrayBuilder`<`undefined` | `object`\[]>

Sets the component's value type to an array of objects.

##### Returns[​](#returns-4 "Direct link to Returns")

`ArrayBuilder`<`undefined` | `object`\[]>

the modified instance of the builder.

***

### ofString[​](#ofstring "Direct link to ofString")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **ofString**(): `ArrayBuilder`<`undefined` | `string`\[]>

Sets the component's value type to an array of strings.

##### Returns[​](#returns-5 "Direct link to Returns")

`ArrayBuilder`<`undefined` | `string`\[]>

the modified instance of the builder.

***

### required[​](#required "Direct link to required")

#### Get Signature[​](#get-signature-5 "Direct link to Get Signature")

> **get** **required**(): [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`NonNullable`<`T`>>

Marks the component property as required.

##### Returns[​](#returns-6 "Direct link to Returns")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`NonNullable`<`T`>>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#required)

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-6 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-7 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#valued)

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-8 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`build`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#build)

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `ArrayBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-9 "Direct link to Returns")

`ArrayBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#calculable)

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-10 "Direct link to Returns")

`this`

the cloned instance of the builder.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#clone)

***

### default()[​](#default "Direct link to default()")

> **default**(`value`): `this`

Sets the default value for the component property.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`T`

the default value.

#### Returns[​](#returns-11 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#default)

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-12 "Direct link to Returns")

`string`

the annotation name.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`getName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#getname)

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-13 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`hideEditor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#hideeditor)

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `ArrayBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-14 "Direct link to Returns")

`ArrayBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`hinted`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#hinted)

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `ArrayBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-15 "Direct link to Returns")

`ArrayBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`named`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#named)

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-16 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`setup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#setup)

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `ArrayBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-17 "Direct link to Returns")

`ArrayBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#uncontrolledvalue)

***

### validated()[​](#validated "Direct link to validated()")

> **validated**(`validator`, `errorMap`): `this`

Modifies the component property metadata builder with validation properties.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### validator[​](#validator "Direct link to validator")

[`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)<`T`>

the validation function.

##### errorMap[​](#errormap "Direct link to errorMap")

[`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

the validation error settings.

#### Returns[​](#returns-18 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`validated`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#validated)

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-19 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`withEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#witheditorprops)


---

# Class: BaseBuilder\<T>

The base builder class to define the metadata property of the form builder component.

## Extended by[​](#extended-by "Direct link to Extended by")

* [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)
* [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new BaseBuilder**<`T`>(): `BaseBuilder`<`T`>

#### Returns[​](#returns "Direct link to Returns")

`BaseBuilder`<`T`>

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

## Accessors[​](#accessors "Direct link to Accessors")

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-1 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-2 "Direct link to Returns")

`this`

the component property that can be localized.

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the non-localizable component property.

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-4 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-5 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `BaseBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-6 "Direct link to Returns")

`BaseBuilder`<`T`>

the modified instance of the builder.

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-7 "Direct link to Returns")

`this`

the cloned instance of the builder.

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-8 "Direct link to Returns")

`string`

the annotation name.

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-9 "Direct link to Returns")

`this`

the modified instance of the builder.

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `BaseBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-10 "Direct link to Returns")

`BaseBuilder`<`T`>

the modified instance of the builder.

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `BaseBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-11 "Direct link to Returns")

`BaseBuilder`<`T`>

the modified instance of the builder.

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-12 "Direct link to Returns")

`this`

the modified instance of the builder.

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `BaseBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-13 "Direct link to Returns")

`BaseBuilder`<`T`>

the modified instance of the builder.

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-14 "Direct link to Returns")

`this`

the modified instance of the builder.


---

# Class: BuilderOptions

Options for building an annotation.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new BuilderOptions**(): `BuilderOptions`

#### Returns[​](#returns "Direct link to Returns")

`BuilderOptions`

## Properties[​](#properties "Direct link to Properties")

### annotationType[​](#annotationtype "Direct link to annotationType")

> **annotationType**: [`AnnotationType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AnnotationType) = `'Module'`

Type of component property description in the form builder.

***

### autoName[​](#autoname "Direct link to autoName")

> **autoName**: `boolean` = `true`

Flag if true, the property name will be automatically converted in the designer from a camel case string to a human-readable string.


---

# Class: BuilderView

Represents all the metadata of the form builder components.

## Extends[​](#extends "Direct link to Extends")

* [`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new BuilderView**(`builderComponents`): `BuilderView`

Creates metadata for form builder components.

#### Parameters[​](#parameters "Direct link to Parameters")

##### builderComponents[​](#buildercomponents "Direct link to builderComponents")

[`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)\[]

the array of metadata of form builder components.

#### Returns[​](#returns "Direct link to Returns")

`BuilderView`

#### Overrides[​](#overrides "Direct link to Overrides")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#constructor)

## Properties[​](#properties "Direct link to Properties")

### builderComponents[​](#buildercomponents-1 "Direct link to builderComponents")

> **builderComponents**: [`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)\[]

the array of metadata of form builder components.

***

### i18nDescriptions?[​](#i18ndescriptions "Direct link to i18nDescriptions?")

> `optional` **i18nDescriptions**: `Record`<`` `${string}-${string}` ``, [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>\[]

The description of the component library in different languages.

***

### paletteFilter()?[​](#palettefilter "Direct link to paletteFilter()?")

> `optional` **paletteFilter**: (`builderComponent`) => `boolean`

The function for filtering components on the component palette.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### builderComponent[​](#buildercomponent "Direct link to builderComponent")

[`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)

#### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

## Accessors[​](#accessors "Direct link to Accessors")

### viewerWrappers[​](#viewerwrappers "Direct link to viewerWrappers")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **viewerWrappers**(): [`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)\[]

Retrieves the viewer wrappers array.

##### Returns[​](#returns-2 "Direct link to Returns")

[`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)\[]

the viewer wrappers array.

Retrieves the viewer wrappers array.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`viewerWrappers`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#viewerwrappers)

## Methods[​](#methods "Direct link to Methods")

### addComponent()[​](#addcomponent "Direct link to addComponent()")

> **addComponent**(`component`): `void`

Adds the component metadata to the form builder.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### component[​](#component "Direct link to component")

[`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)

the component metadata.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### all()[​](#all "Direct link to all()")

> **all**(): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

#### Returns[​](#returns-4 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

all component metadata for the form viewer.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`all`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#all)

***

### define()[​](#define "Direct link to define()")

> **define**(`model`): `void`

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### model[​](#model "Direct link to model")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc "Direct link to Inherit Doc")

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`define`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#define)

***

### filterModels()[​](#filtermodels "Direct link to filterModels()")

> **filterModels**(`predicate`): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### predicate[​](#predicate "Direct link to predicate")

(`model`) => `boolean`

the filter function.

#### Returns[​](#returns-6 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

the array of component metadata filtered using the predicate function.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`filterModels`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#filtermodels)

***

### find()[​](#find "Direct link to find()")

> **find**(`type`): `undefined` | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-7 "Direct link to Returns")

`undefined` | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

the component metadata for the form viewer for the specified type or undefined.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`find`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#find)

***

### findMeta()[​](#findmeta "Direct link to findMeta()")

> **findMeta**(`type`): `undefined` | [`Meta`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta)

Returns the component metadata for the specified component type name or undefined.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### type[​](#type-1 "Direct link to type")

`string`

the component type name.

#### Returns[​](#returns-8 "Direct link to Returns")

`undefined` | [`Meta`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta)

the component metadata for the specified component type name or undefined.

***

### get()[​](#get "Direct link to get()")

> **get**(`type`): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### type[​](#type-2 "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-9 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

the component metadata for the form viewer for the specified type.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`get`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#get)

***

### getCssLoaders()[​](#getcssloaders "Direct link to getCssLoaders()")

> **getCssLoaders**(`biDi`): () => `Promise`<`void`>\[]

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### biDi[​](#bidi "Direct link to biDi")

[`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi)

the BiDi object for which to retrieve the CSS loaders.

#### Returns[​](#returns-10 "Direct link to Returns")

() => `Promise`<`void`>\[]

the array containing the CSS loaders for the specified BiDi.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`getCssLoaders`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#getcssloaders)

***

### getMeta()[​](#getmeta "Direct link to getMeta()")

> **getMeta**(`type`): [`Meta`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta)

Returns the component metadata for the specified component type name.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### type[​](#type-3 "Direct link to type")

`string`

the component type name.

#### Returns[​](#returns-11 "Direct link to Returns")

[`Meta`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta)

the component metadata for the specified component type name.

***

### removeComponent()[​](#removecomponent "Direct link to removeComponent()")

> **removeComponent**(`name`): `void`

Removes the component metadata from the form builder.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the component type name.

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

***

### withComponentLibraryDescription()[​](#withcomponentlibrarydescription "Direct link to withComponentLibraryDescription()")

> **withComponentLibraryDescription**(`i18nDescription`): `this`

Adds a description of the component library in different languages.

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### i18nDescription[​](#i18ndescription "Direct link to i18nDescription")

`Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>

the description of the component library in different languages.

#### Returns[​](#returns-13 "Direct link to Returns")

`this`

the instance of the BuilderView class.

***

### withCssLoader()[​](#withcssloader "Direct link to withCssLoader()")

> **withCssLoader**(`cssLoaderType`, `loader`): `BuilderView`

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### cssLoaderType[​](#cssloadertype "Direct link to cssLoaderType")

[`CssLoaderType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CssLoaderType)

the BiDi layout type, either 'common', 'ltr', or 'rtl'.

##### loader[​](#loader "Direct link to loader")

() => `Promise`<`void`>

the function that returns a Promise to load CSS or other required localization resources.

#### Returns[​](#returns-14 "Direct link to Returns")

`BuilderView`

the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) instance.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`withCssLoader`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#withcssloader)

***

### withPaletteFilter()[​](#withpalettefilter "Direct link to withPaletteFilter()")

> **withPaletteFilter**(`filter`): `this`

Sets a function for filtering components on the component palette.

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### filter[​](#filter "Direct link to filter")

(`builderComponent`) => `boolean`

the component filtering function.

#### Returns[​](#returns-15 "Direct link to Returns")

`this`

the instance of the BuilderView class.

***

### withTemplates()[​](#withtemplates "Direct link to withTemplates()")

> **withTemplates**(`templates`): `this`

Creates metadata for the form builder for templates from the specified template names.

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### templates[​](#templates "Direct link to templates")

`string`\[]

the array of template names.

#### Returns[​](#returns-16 "Direct link to Returns")

`this`

the instance of the BuilderView class.

***

### withViewerWrapper()[​](#withviewerwrapper "Direct link to withViewerWrapper()")

> **withViewerWrapper**(`wrapper`): `BuilderView`

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### wrapper[​](#wrapper "Direct link to wrapper")

[`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)

the viewer wrapper to be added. The wrapper is a component that wraps the form viewer.

#### Returns[​](#returns-17 "Direct link to Returns")

`BuilderView`

the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) instance.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`withViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#withviewerwrapper)

***

### create()[​](#create "Direct link to create()")

> `static` **create**(`models`): [`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

Static wrapper for the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) constructor.

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### models[​](#models "Direct link to models")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

the components metadata.

#### Returns[​](#returns-18 "Direct link to Returns")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) instance.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View).[`create`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View#create)

***

### createTemplateComponent()[​](#createtemplatecomponent "Direct link to createTemplateComponent()")

> `static` **createTemplateComponent**(`name`): [`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)

Creates an instance of BuilderComponent for the specified template name.

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### name[​](#name-1 "Direct link to name")

`string`

the template name

#### Returns[​](#returns-19 "Direct link to Returns")

[`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)

the BuilderComponent instance.


---

# Class: CalculableResult

Calculable result.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new CalculableResult**(`error`, `result?`, `exceptions?`, `warning?`): `CalculableResult`

Constructor.

#### Parameters[​](#parameters "Direct link to Parameters")

##### error[​](#error "Direct link to error")

`boolean` = `false`

the error.

##### result?[​](#result "Direct link to result?")

`any`

the result.

##### exceptions?[​](#exceptions "Direct link to exceptions?")

`Error`\[]

the exceptions.

##### warning?[​](#warning "Direct link to warning?")

`boolean`

the warning.

#### Returns[​](#returns "Direct link to Returns")

`CalculableResult`

## Properties[​](#properties "Direct link to Properties")

### error[​](#error-1 "Direct link to error")

> `readonly` **error**: `boolean` = `false`

the error.

***

### exceptions?[​](#exceptions-1 "Direct link to exceptions?")

> `readonly` `optional` **exceptions**: `Error`\[]

the exceptions.

***

### result?[​](#result-1 "Direct link to result?")

> `readonly` `optional` **result**: `any`

the result.

***

### warning?[​](#warning-1 "Direct link to warning?")

> `readonly` `optional` **warning**: `boolean`

the warning.

## Methods[​](#methods "Direct link to Methods")

### error()[​](#error-2 "Direct link to error()")

> `static` **error**(`exceptions`): `CalculableResult`

Creates a new instance of CalculableResult class with an error.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### exceptions[​](#exceptions-2 "Direct link to exceptions")

`Error`\[]

the exception array.

#### Returns[​](#returns-1 "Direct link to Returns")

`CalculableResult`

the new instance of CalculableResult class.

***

### success()[​](#success "Direct link to success()")

> `static` **success**(`result`): `CalculableResult`

Creates a new instance of the CalculableResult class with a successful result.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### result[​](#result-2 "Direct link to result")

`any`

the calculable result.

#### Returns[​](#returns-2 "Direct link to Returns")

`CalculableResult`

the new instance of CalculableResult class.

***

### warning()[​](#warning-2 "Direct link to warning()")

> `static` **warning**(`result`): `CalculableResult`

Creates a new instance of the CalculableResult class with a warning result.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### result[​](#result-3 "Direct link to result")

`any`

the calculable result.

#### Returns[​](#returns-3 "Direct link to Returns")

`CalculableResult`

the new instance of CalculableResult class.


---

# Class: ComponentData

This tree of elements contains the data required to display the component. It is synchronized with the ComponentStore tree.

## Implements[​](#implements "Direct link to Implements")

* [`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ComponentData**(`componentStore`, `model`, `childFactory`, `getFormValidationResult?`): `ComponentData`

Constructor.

#### Parameters[​](#parameters "Direct link to Parameters")

##### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

##### model[​](#model "Direct link to model")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

the component metadata for the form viewer.

##### childFactory[​](#childfactory "Direct link to childFactory")

(`componentStore`) => `ComponentData`

the factory function that creates ComponentData instance.

##### getFormValidationResult?[​](#getformvalidationresult "Direct link to getFormValidationResult?")

() => `Promise`<`Record`<`string`, `string`>\[]>

the function that returns a form validation results.

#### Returns[​](#returns "Direct link to Returns")

`ComponentData`

## Properties[​](#properties "Direct link to Properties")

### children[​](#children "Direct link to children")

> **children**: `ComponentData`\[] = `[]`

The child nodes in the component data tree.

***

### componentState[​](#componentstate "Direct link to componentState")

> **componentState**: [`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState) = `defaultComponentState`

The state of the component. \*\*Internal use only.

***

### dataRootProvider?[​](#datarootprovider "Direct link to dataRootProvider?")

> `optional` **dataRootProvider**: [`IDataRootProvider`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IDataRootProvider)

Specifies the root component for the data in the component tree. **Internal use only.**

***

### field?[​](#field "Direct link to field?")

> `optional` **field**: [`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)

The field with the form data.

***

### getInitialData()?[​](#getinitialdata "Direct link to getInitialData()?")

> `optional` **getInitialData**: () => `unknown`

The function for getting initial data. **Internal use only.**

#### Returns[​](#returns-1 "Direct link to Returns")

`unknown`

***

### id[​](#id "Direct link to id")

> `readonly` **id**: `string`

The unique identifier.

***

### index?[​](#index "Direct link to index?")

> `optional` **index**: `number`

Specifies the index in the array if the component is in the component array. This is not an index in a parent-child structure.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`index`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#index)

***

### model[​](#model-1 "Direct link to model")

> `readonly` **model**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

The component metadata.

***

### parent?[​](#parent "Direct link to parent?")

> `optional` **parent**: `ComponentData`

The parent node in the component data tree.

***

### setInitialData?[​](#setinitialdata "Direct link to setInitialData?")

> `optional` **setInitialData**: [`SetInitialDataFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SetInitialDataFn)

The function for updating initial data. **Internal use only.**

***

### store[​](#store "Direct link to store")

> `readonly` **store**: [`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

The component settings.

***

### userDefinedProps?[​](#userdefinedprops "Direct link to userDefinedProps?")

> `optional` **userDefinedProps**: `Record`<`string`, `any`>

User defined properties of the React component.

***

### validating[​](#validating "Direct link to validating")

> **validating**: `boolean` = `false`

If true, then validation is in progress.

## Accessors[​](#accessors "Direct link to Accessors")

### allChildren[​](#allchildren "Direct link to allChildren")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **allChildren**(): `ComponentData`\[]

##### Returns[​](#returns-2 "Direct link to Returns")

`ComponentData`\[]

an array of all children components.

***

### allComponentFields[​](#allcomponentfields "Direct link to allComponentFields")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **allComponentFields**(): [`ComponentField`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentField)\[]

##### Returns[​](#returns-3 "Direct link to Returns")

[`ComponentField`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentField)\[]

an array of all component fields, including non-unique data keys.

***

### allFields[​](#allfields "Direct link to allFields")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **allFields**(): [`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)\[]

##### Returns[​](#returns-4 "Direct link to Returns")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)\[]

an array of all fields, including non-unique data keys.

***

### data[​](#data "Direct link to data")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **data**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-5 "Direct link to Returns")

`Record`<`string`, `unknown`>

the Record with all the form data.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`data`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#data)

***

### dataRoot[​](#dataroot "Direct link to dataRoot")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **dataRoot**(): `ComponentData`

##### Returns[​](#returns-6 "Direct link to Returns")

`ComponentData`

the root component for the data in the component tree.

***

### errors[​](#errors "Direct link to errors")

#### Get Signature[​](#get-signature-5 "Direct link to Get Signature")

> **get** **errors**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-7 "Direct link to Returns")

`Record`<`string`, `unknown`>

the Record with all validation error messages.

#### Set Signature[​](#set-signature "Direct link to Set Signature")

> **set** **errors**(`errors`): `void`

Sets the form error messages.

##### Parameters[​](#parameters-1 "Direct link to Parameters")

###### errors[​](#errors-1 "Direct link to errors")

`Record`<`string`, `unknown`>

##### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`errors`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#errors)

***

### events[​](#events "Direct link to events")

#### Get Signature[​](#get-signature-6 "Direct link to Get Signature")

> **get** **events**(): [`ComponentDataEvents`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentDataEvents)

##### Returns[​](#returns-9 "Direct link to Returns")

[`ComponentDataEvents`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentDataEvents)

the ComponentDataEvents object.

***

### fields[​](#fields "Direct link to fields")

#### Get Signature[​](#get-signature-7 "Direct link to Get Signature")

> **get** **fields**(): `Map`<`string`, [`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)>

##### Returns[​](#returns-10 "Direct link to Returns")

`Map`<`string`, [`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)>

all the fields in the tree as a map. Starts from this node.

***

### hasErrors[​](#haserrors "Direct link to hasErrors")

#### Get Signature[​](#get-signature-8 "Direct link to Get Signature")

> **get** **hasErrors**(): `boolean`

true if the form contains errors, otherwise false.

##### Returns[​](#returns-11 "Direct link to Returns")

`boolean`

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`hasErrors`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#haserrors)

***

### initialData[​](#initialdata "Direct link to initialData")

#### Get Signature[​](#get-signature-9 "Direct link to Get Signature")

> **get** **initialData**(): `unknown`

##### Returns[​](#returns-12 "Direct link to Returns")

`unknown`

the initial data.

***

### isRoot[​](#isroot "Direct link to isRoot")

#### Get Signature[​](#get-signature-10 "Direct link to Get Signature")

> **get** **isRoot**(): `boolean`

##### Returns[​](#returns-13 "Direct link to Returns")

`boolean`

true if it has no parent ComponentData, false otherwise.

***

### isValidating[​](#isvalidating "Direct link to isValidating")

#### Get Signature[​](#get-signature-11 "Direct link to Get Signature")

> **get** **isValidating**(): `boolean`

If true, then validation is in progress.

##### Returns[​](#returns-14 "Direct link to Returns")

`boolean`

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`isValidating`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#isvalidating)

***

### key[​](#key "Direct link to key")

#### Get Signature[​](#get-signature-12 "Direct link to Get Signature")

> **get** **key**(): `string`

##### Returns[​](#returns-15 "Direct link to Returns")

`string`

the key of this node (same as the key of the ComponentStore).

***

### nearestIndex[​](#nearestindex "Direct link to nearestIndex")

#### Get Signature[​](#get-signature-13 "Direct link to Get Signature")

> **get** **nearestIndex**(): `undefined` | `number`

##### Returns[​](#returns-16 "Direct link to Returns")

`undefined` | `number`

the index in the array if the component is in the component array (looks for the nearest index in the component hierarchy).

***

### parentData[​](#parentdata "Direct link to parentData")

#### Get Signature[​](#get-signature-14 "Direct link to Get Signature")

> **get** **parentData**(): `undefined` | `Record`<`string`, `unknown`>

##### Returns[​](#returns-17 "Direct link to Returns")

`undefined` | `Record`<`string`, `unknown`>

the object to read and modify parent data (available for array elements).

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`parentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#parentdata)

***

### root[​](#root "Direct link to root")

#### Get Signature[​](#get-signature-15 "Direct link to Get Signature")

> **get** **root**(): `ComponentData`

##### Returns[​](#returns-18 "Direct link to Returns")

`ComponentData`

the root of the component tree.

***

### rootData[​](#rootdata "Direct link to rootData")

#### Get Signature[​](#get-signature-16 "Direct link to Get Signature")

> **get** **rootData**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-19 "Direct link to Returns")

`Record`<`string`, `unknown`>

the object to read and modify root form data.

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`rootData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#rootdata)

***

### state[​](#state "Direct link to state")

#### Get Signature[​](#get-signature-17 "Direct link to Get Signature")

> **get** **state**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-20 "Direct link to Returns")

`Record`<`string`, `unknown`>

A user-defined key-value observable storage. Utilize it to store and share any custom data.

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`state`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#state)

## Methods[​](#methods "Direct link to Methods")

### clear()[​](#clear "Direct link to clear()")

> **clear**(`clearInitialData`): `void`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### clearInitialData[​](#clearinitialdata "Direct link to clearInitialData")

`boolean` = `true`

#### Returns[​](#returns-21 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`clear`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#clear)

***

### delete()[​](#delete "Direct link to delete()")

> **delete**(): `void`

Deletes this node from the tree.

#### Returns[​](#returns-22 "Direct link to Returns")

`void`

***

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**(): `void`

Dispose method that releases resources used by the object. It disposes the field and all the children objects.

#### Returns[​](#returns-23 "Direct link to Returns")

`void`

***

### findByKey()[​](#findbykey "Direct link to findByKey()")

> **findByKey**(`key`): `undefined` | `ComponentData`

Find the node with the given key.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the key to find.

#### Returns[​](#returns-24 "Direct link to Returns")

`undefined` | `ComponentData`

the node or undefined if not found.

***

### generatedData()[​](#generateddata "Direct link to generatedData()")

> **generatedData**(): `Record`<`string`, `unknown`>

#### Returns[​](#returns-25 "Direct link to Returns")

`Record`<`string`, `unknown`>

the generated form data.

***

### getValidationResult()[​](#getvalidationresult "Direct link to getValidationResult()")

> **getValidationResult**(): `Promise`<`undefined`>

#### Returns[​](#returns-26 "Direct link to Returns")

`Promise`<`undefined`>

the [ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) validation results.

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`getValidationResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#getvalidationresult)

***

### insertAfterMe()[​](#insertafterme "Direct link to insertAfterMe()")

> **insertAfterMe**(`inserted`): `void`

Inserts the given node after this node.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### inserted[​](#inserted "Direct link to inserted")

`ComponentData`

the node to insert.

#### Returns[​](#returns-27 "Direct link to Returns")

`void`

***

### insertBeforeMe()[​](#insertbeforeme "Direct link to insertBeforeMe()")

> **insertBeforeMe**(`inserted`): `void`

Inserts the given node before this node.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### inserted[​](#inserted-1 "Direct link to inserted")

`ComponentData`

the node to insert.

#### Returns[​](#returns-28 "Direct link to Returns")

`void`

***

### reset()[​](#reset "Direct link to reset()")

> **reset**(`clearInitialData`): `void`

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### clearInitialData[​](#clearinitialdata-1 "Direct link to clearInitialData")

`boolean` = `true`

#### Returns[​](#returns-29 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-1 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`reset`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#reset)

***

### setAllErrors()[​](#setallerrors "Direct link to setAllErrors()")

> **setAllErrors**(`message?`): `void`

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### message?[​](#message "Direct link to message?")

`string`

#### Returns[​](#returns-30 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-2 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`setAllErrors`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#setallerrors)

***

### setParent()[​](#setparent "Direct link to setParent()")

> **setParent**(`newParent`): `void`

Sets the new parent for this node.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### newParent[​](#newparent "Direct link to newParent")

`ComponentData`

the new parent.

#### Returns[​](#returns-31 "Direct link to Returns")

`void`

***

### unifyKeys()[​](#unifykeys "Direct link to unifyKeys()")

> **unifyKeys**(`root`): `Map`<`string`, `string`>

Assigns unique keys to the items in the tree.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### root[​](#root-1 "Direct link to root")

`ComponentData`

the root of the tree to unify keys. Defaults to the root of this tree.

#### Returns[​](#returns-32 "Direct link to Returns")

`Map`<`string`, `string`>

the map of new keys to old keys.

***

### unifyTree()[​](#unifytree "Direct link to unifyTree()")

> **unifyTree**(): `void`

Assigns unique keys to the items in the tree.

#### Returns[​](#returns-33 "Direct link to Returns")

`void`

***

### updateInitialData()[​](#updateinitialdata "Direct link to updateInitialData()")

> **updateInitialData**(`key`, `value`): `void`

Updates the initial data. **Internal use only.**

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### key[​](#key-2 "Direct link to key")

the initial data key.

`string` | `number`

##### value[​](#value "Direct link to value")

`unknown`

the initial data value.

#### Returns[​](#returns-34 "Direct link to Returns")

`void`

***

### validate()[​](#validate "Direct link to validate()")

> **validate**(): `Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)>

#### Returns[​](#returns-35 "Direct link to Returns")

`Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)>

the [ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) validation results.

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData).[`validate`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData#validate)


---

# Class: ComponentDataEvents

Represents a class that holds events related to component data.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ComponentDataEvents**(): `ComponentDataEvents`

#### Returns[​](#returns "Direct link to Returns")

`ComponentDataEvents`

## Properties[​](#properties "Direct link to Properties")

### onAfterKeyChanged[​](#onafterkeychanged "Direct link to onAfterKeyChanged")

> `readonly` **onAfterKeyChanged**: [`SyncEvent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SyncEvent)<[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData), [`ComponentKeyChangedEventArgs`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentKeyChangedEventArgs)>

An event that occurs after a component key change.

***

### onBeforeDelete[​](#onbeforedelete "Direct link to onBeforeDelete")

> `readonly` **onBeforeDelete**: [`SyncEvent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SyncEvent)<[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData), `undefined`>

An event that occurs before a component is removed from the component tree.

## Methods[​](#methods "Direct link to Methods")

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**(): `void`

Unsubscribe from all events.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`


---

# Class: ComponentKeyChangedEventArgs

Represents the event argument for the event when the component key changes.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ComponentKeyChangedEventArgs**(`oldKey`, `newKey`): `ComponentKeyChangedEventArgs`

Constructs a new instance of the ComponentKeyChangedEventArgs class.

#### Parameters[​](#parameters "Direct link to Parameters")

##### oldKey[​](#oldkey "Direct link to oldKey")

`string`

the old key.

##### newKey[​](#newkey "Direct link to newKey")

`string`

the new key.

#### Returns[​](#returns "Direct link to Returns")

`ComponentKeyChangedEventArgs`

## Properties[​](#properties "Direct link to Properties")

### newKey[​](#newkey-1 "Direct link to newKey")

> `readonly` **newKey**: `string`

the new key.

***

### oldKey[​](#oldkey-1 "Direct link to oldKey")

> `readonly` **oldKey**: `string`

the old key.


---

# Class: ComponentState

Calculates all the properties of the form view component.

## Implements[​](#implements "Direct link to Implements")

* [`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ComponentState**(`data`, `store`, `localizer`, `computeChildren`, `context?`): `ComponentState`

Creates an instance that calculates the properties of the form viewer component.

#### Parameters[​](#parameters "Direct link to Parameters")

##### data[​](#data "Direct link to data")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the data needed to display the component.

##### store[​](#store "Direct link to store")

[`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)

the form viewer settings.

##### localizer[​](#localizer "Direct link to localizer")

[`ComponentStoreLocalizer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStoreLocalizer)

the function to localize the properties of a component, returns a Record with localized properties.

##### computeChildren[​](#computechildren "Direct link to computeChildren")

[`ComputeChildren`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComputeChildren)

the function that calculates all child properties of a component.

##### context?[​](#context "Direct link to context?")

[`ComponentPropertiesContext`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertiesContext)

the context for working with component properties.

#### Returns[​](#returns "Direct link to Returns")

`ComponentState`

## Properties[​](#properties "Direct link to Properties")

### computeChildren[​](#computechildren-1 "Direct link to computeChildren")

> `readonly` **computeChildren**: [`ComputeChildren`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComputeChildren)

the function that calculates all child properties of a component.

***

### context[​](#context-1 "Direct link to context")

> `readonly` **context**: [`ComponentPropertiesContext`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertiesContext)

The context for working with component properties.

***

### data[​](#data-1 "Direct link to data")

> `readonly` **data**: [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the data needed to display the component.

***

### localizer[​](#localizer-1 "Direct link to localizer")

> `readonly` **localizer**: [`ComponentStoreLocalizer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStoreLocalizer)

the function to localize the properties of a component, returns a Record with localized properties.

***

### store[​](#store-1 "Direct link to store")

> `readonly` **store**: [`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)

the form viewer settings.

## Accessors[​](#accessors "Direct link to Accessors")

### calculatedProps[​](#calculatedprops "Direct link to calculatedProps")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **calculatedProps**(): `Record`<`string`, `any`>

##### Returns[​](#returns-1 "Direct link to Returns")

`Record`<`string`, `any`>

the values for all properties of the component, calculates the values of the calculated properties.

***

### className[​](#classname "Direct link to className")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **className**(): `object`

Calculates and returns className property.

##### Returns[​](#returns-2 "Direct link to Returns")

`object`

the Record that contains the className property for the component.

###### className[​](#classname-1 "Direct link to className")

> **className**: `string`

***

### disabled[​](#disabled "Direct link to disabled")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **disabled**(): `undefined` | {\[`key`: `string`]: `any`; }

##### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | {\[`key`: `string`]: `any`; }

the disabled property of a component if the component has a disabled flag.

***

### events[​](#events "Direct link to events")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **events**(): `Record`<`string`, (...`args`) => `Promise`<`void`>>

##### Returns[​](#returns-4 "Direct link to Returns")

`Record`<`string`, (...`args`) => `Promise`<`void`>>

the component event handlers that send events to the event bus.

***

### get[​](#get "Direct link to get")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **get**(): `Record`<`string`, `any`>

##### Returns[​](#returns-5 "Direct link to Returns")

`Record`<`string`, `any`>

combined in order of priority component properties.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`get`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#get)

***

### htmlAttributes[​](#htmlattributes "Direct link to htmlAttributes")

#### Get Signature[​](#get-signature-5 "Direct link to Get Signature")

> **get** **htmlAttributes**(): `undefined` | [`HtmlAttribute`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/HtmlAttribute)

##### Returns[​](#returns-6 "Direct link to Returns")

`undefined` | [`HtmlAttribute`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/HtmlAttribute)

all arbitrary HTML attributes of the component.

***

### isDisabled[​](#isdisabled "Direct link to isDisabled")

#### Get Signature[​](#get-signature-6 "Direct link to Get Signature")

> **get** **isDisabled**(): `any`

##### Returns[​](#returns-7 "Direct link to Returns")

`any`

true if the component is disabled, false otherwise.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`isDisabled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#isdisabled)

***

### isReadOnly[​](#isreadonly "Direct link to isReadOnly")

#### Get Signature[​](#get-signature-7 "Direct link to Get Signature")

> **get** **isReadOnly**(): `any`

##### Returns[​](#returns-8 "Direct link to Returns")

`any`

true if the component is read-only, false otherwise.

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`isReadOnly`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#isreadonly)

***

### localizedProps[​](#localizedprops "Direct link to localizedProps")

#### Get Signature[​](#get-signature-8 "Direct link to Get Signature")

> **get** **localizedProps**(): `Record`<`string`, `any`>

##### Returns[​](#returns-9 "Direct link to Returns")

`Record`<`string`, `any`>

component localized properties.

***

### ownProps[​](#ownprops "Direct link to ownProps")

#### Get Signature[​](#get-signature-9 "Direct link to Get Signature")

> **get** **ownProps**(): `object`

##### Returns[​](#returns-10 "Direct link to Returns")

`object`

combined in order of priority component properties without children props.

###### className[​](#classname-2 "Direct link to className")

> **className**: `string`

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`ownProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#ownprops)

***

### propsWithoutChildren[​](#propswithoutchildren "Direct link to propsWithoutChildren")

#### Get Signature[​](#get-signature-10 "Direct link to Get Signature")

> **get** **propsWithoutChildren**(): `Record`<`string`, `any`>

##### Returns[​](#returns-11 "Direct link to Returns")

`Record`<`string`, `any`>

combined component properties in order of priority, excluding child components, the className property does not contain styles additionally defined for the component.

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`propsWithoutChildren`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#propswithoutchildren)

***

### readOnly[​](#readonly "Direct link to readOnly")

#### Get Signature[​](#get-signature-11 "Direct link to Get Signature")

> **get** **readOnly**(): `undefined` | {\[`key`: `string`]: `any`; }

##### Returns[​](#returns-12 "Direct link to Returns")

`undefined` | {\[`key`: `string`]: `any`; }

the read-only property of a component if the component has a read-only flag.

***

### required[​](#required "Direct link to required")

#### Get Signature[​](#get-signature-12 "Direct link to Get Signature")

> **get** **required**(): `undefined` | `Record`<`string`, `boolean`>

##### Returns[​](#returns-13 "Direct link to Returns")

`undefined` | `Record`<`string`, `boolean`>

the required property of a component if the component has a required flag.

***

### style[​](#style "Direct link to style")

#### Get Signature[​](#get-signature-13 "Direct link to Get Signature")

> **get** **style**(): `undefined` | { `style`: `any`; }

##### Returns[​](#returns-14 "Direct link to Returns")

`undefined` | { `style`: `any`; }

the Record that contains the style property for the component.

***

### value[​](#value "Direct link to value")

#### Get Signature[​](#get-signature-14 "Direct link to Get Signature")

> **get** **value**(): `undefined` | {\[`key`: `string`]: `unknown`; }

##### Returns[​](#returns-15 "Direct link to Returns")

`undefined` | {\[`key`: `string`]: `unknown`; }

the component's field value data, if the component can have a field value.

***

### wrapperClassName[​](#wrapperclassname "Direct link to wrapperClassName")

#### Get Signature[​](#get-signature-15 "Direct link to Get Signature")

> **get** **wrapperClassName**(): `string`

Calculates and returns wrapper className property.

##### Returns[​](#returns-16 "Direct link to Returns")

`string`

the className for the wrapper of component.

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`wrapperClassName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#wrapperclassname)

***

### wrapperStyle[​](#wrapperstyle "Direct link to wrapperStyle")

#### Get Signature[​](#get-signature-16 "Direct link to Get Signature")

> **get** **wrapperStyle**(): `undefined` | { `style`: `any`; }

##### Returns[​](#returns-17 "Direct link to Returns")

`undefined` | { `style`: `any`; }

the Record that contains the style property for the wrapper of component.

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`wrapperStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#wrapperstyle)

## Methods[​](#methods "Direct link to Methods")

### children()[​](#children "Direct link to children()")

> **children**(`props`): `Record`<`string`, `any`>

Calculates and returns all child components.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the React component properties.

#### Returns[​](#returns-18 "Direct link to Returns")

`Record`<`string`, `any`>

the Record that contains the child components of a component.

***

### onDidMount()[​](#ondidmount "Direct link to onDidMount()")

> **onDidMount**(): `void`

The method that is called when the component is mounted.

#### Returns[​](#returns-19 "Direct link to Returns")

`void`

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`onDidMount`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#ondidmount)

***

### onWillUnmount()[​](#onwillunmount "Direct link to onWillUnmount()")

> **onWillUnmount**(): `void`

The method that is called when the component is unmounted.

#### Returns[​](#returns-20 "Direct link to Returns")

`void`

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState).[`onWillUnmount`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState#onwillunmount)


---

# Class: ComponentStore

Component settings for serialization in JSON.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ComponentStore**(`key`, `type`): `ComponentStore`

Creates the component settings.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the React component key.

##### type[​](#type "Direct link to type")

`string`

the component type of the form viewer.

#### Returns[​](#returns "Direct link to Returns")

`ComponentStore`

## Properties[​](#properties "Direct link to Properties")

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ComponentStore`\[]

The array of child components.

***

### css?[​](#css "Direct link to css?")

> `optional` **css**: [`Css`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css)

The component CSS styles.

***

### dataKey?[​](#datakey "Direct link to dataKey?")

> `optional` **dataKey**: `string`

The component data key.

***

### disableDataBinding?[​](#disabledatabinding "Direct link to disableDataBinding?")

> `optional` **disableDataBinding**: [`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)<`boolean`>

Disables data binding for the component.

***

### events?[​](#events "Direct link to events?")

> `optional` **events**: `Record`<`string`, [`ActionData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData)\[]>

The set of event handlers.

***

### htmlAttributes?[​](#htmlattributes "Direct link to htmlAttributes?")

> `optional` **htmlAttributes**: [`HtmlAttribute`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/HtmlAttribute)\[]

The set of arbitrary HTML attributes added to the component.

***

### key[​](#key-1 "Direct link to key")

> **key**: `string` = `''`

The React component key.

***

### modal?[​](#modal "Direct link to modal?")

> `optional` **modal**: [`ModalComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ModalComponentStore)

The modal settings.

***

### props[​](#props "Direct link to props")

> **props**: `Record`<`string`, [`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)> = `{}`

The component properties.

***

### renderWhen?[​](#renderwhen "Direct link to renderWhen?")

> `optional` **renderWhen**: [`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)<`any`>

The expression or function to conditionally render a component.

***

### schema?[​](#schema "Direct link to schema?")

> `optional` **schema**: [`BoundValueSchema`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BoundValueSchema)

The component value validation settings.

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

The name of the occupied component property in the parent component.

***

### slotCondition?[​](#slotcondition "Direct link to slotCondition?")

> `optional` **slotCondition**: `string`

The condition for binding a child element to a parent element.

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: [`ComponentStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStyle)

The component styles for the `style` attribute.

***

### tooltipProps?[​](#tooltipprops "Direct link to tooltipProps?")

> `optional` **tooltipProps**: `Record`<`string`, [`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)<`any`>>

The tooltip settings.

***

### type[​](#type-1 "Direct link to type")

> **type**: `string` = `''`

The component type of the form viewer.

***

### wrapperCss?[​](#wrappercss "Direct link to wrapperCss?")

> `optional` **wrapperCss**: [`Css`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css)

The component wrapper CSS styles.

***

### wrapperStyle?[​](#wrapperstyle "Direct link to wrapperStyle?")

> `optional` **wrapperStyle**: [`ComponentStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStyle)

The component wrapper styles for the `style` attribute.

## Methods[​](#methods "Direct link to Methods")

### addEventHandler()[​](#addeventhandler "Direct link to addEventHandler()")

> `static` **addEventHandler**(`store`, `eventName`, `data`): `void`

Adds the event handler for component.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### store[​](#store "Direct link to store")

`ComponentStore`

the target ComponentStore.

##### eventName[​](#eventname "Direct link to eventName")

`string`

the target event name.

##### data[​](#data "Direct link to data")

[`ActionData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData)

the [ActionData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData).

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### addValidationRule()[​](#addvalidationrule "Direct link to addValidationRule()")

> `static` **addValidationRule**(`store`, `key`, `type`): `void`

Adds a validation rule to the component.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### store[​](#store-1 "Direct link to store")

`ComponentStore`

the component settings.

##### key[​](#key-2 "Direct link to key")

`string`

the validation key.

##### type[​](#type-2 "Direct link to type")

[`ValidatorType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorType) = `'internal'`

the validation type.

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

***

### clone()[​](#clone "Direct link to clone()")

> `static` **clone**(`store`): `ComponentStore`

Returns a clone of the specified component settings.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### store[​](#store-2 "Direct link to store")

`ComponentStore`

the component settings.

#### Returns[​](#returns-3 "Direct link to Returns")

`ComponentStore`

the clone of the specified component settings.

***

### createFromObject()[​](#createfromobject "Direct link to createFromObject()")

> `static` **createFromObject**(`value`): `any`

Correctly creates the ComponentStore from deserialized data.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the deserialized data.

#### Returns[​](#returns-4 "Direct link to Returns")

`any`

the component Store.

***

### hasValidationRule()[​](#hasvalidationrule "Direct link to hasValidationRule()")

> `static` **hasValidationRule**(`store`, `key`): `undefined` | `boolean`

Returns true if the component has a validation rule.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### store[​](#store-3 "Direct link to store")

`ComponentStore`

the component settings.

##### key[​](#key-3 "Direct link to key")

`string`

the validation key.

#### Returns[​](#returns-5 "Direct link to Returns")

`undefined` | `boolean`

true if the component has a validation rule, otherwise false.

***

### removeValidationRule()[​](#removevalidationrule "Direct link to removeValidationRule()")

> `static` **removeValidationRule**(`store`, `key`): `void`

Removes a validation rule from the component.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### store[​](#store-4 "Direct link to store")

`ComponentStore`

the component settings.

##### key[​](#key-4 "Direct link to key")

`string`

the validation key.

#### Returns[​](#returns-6 "Direct link to Returns")

`void`


---

# Class: ContainerAnnotation

Metadata for the component container property for the form builder. The Container property of a component can contain other React components.

## Extends[​](#extends "Direct link to Extends")

* [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ContainerAnnotation**(`key`, `name`): `ContainerAnnotation`

Creates metadata for a React component property.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the property name.

##### name[​](#name "Direct link to name")

`string`

the human-readable property name.

#### Returns[​](#returns "Direct link to Returns")

`ContainerAnnotation`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#constructor)

## Properties[​](#properties "Direct link to Properties")

### bindingType?[​](#bindingtype "Direct link to bindingType?")

> `readonly` `optional` **bindingType**: [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)

The component property binding type.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`bindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#bindingtype)

***

### calculable[​](#calculable "Direct link to calculable")

> `readonly` **calculable**: `boolean` = `true`

True if the property value can be a calculated property, false otherwise.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#calculable)

***

### controlsRequiredProp[​](#controlsrequiredprop "Direct link to controlsRequiredProp")

> `readonly` **controlsRequiredProp**: `boolean` = `false`

True if the property value controls a required flag, false otherwise.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`controlsRequiredProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#controlsrequiredprop)

***

### dataBindingType[​](#databindingtype "Direct link to dataBindingType")

> `readonly` **dataBindingType**: [`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

The type of component data binding.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`dataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#databindingtype)

***

### default?[​](#default "Direct link to default?")

> `readonly` `optional` **default**: `any`

The default property value.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#default)

***

### defaultEditor?[​](#defaulteditor "Direct link to defaultEditor?")

> `optional` **defaultEditor**: [`NodeEditorType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType)

The default editor.

***

### disabled[​](#disabled "Direct link to disabled")

> `readonly` **disabled**: `boolean` = `false`

True if the property value controls a disabled flag, false otherwise.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`disabled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#disabled)

***

### editor[​](#editor "Direct link to editor")

> `readonly` **editor**: `string`

The name of the component's property editor.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editor)

***

### editorProps?[​](#editorprops "Direct link to editorProps?")

> `readonly` `optional` **editorProps**: `any`

Additional properties for the component property editor.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editorprops)

***

### errorMap?[​](#errormap "Direct link to errorMap?")

> `readonly` `optional` **errorMap**: [`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

Message and/or error code for the validation function.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`errorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#errormap)

***

### hint?[​](#hint "Direct link to hint?")

> `readonly` `optional` **hint**: `ReactNode`

The hint for the component property.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`hint`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#hint)

***

### insertPredicate()?[​](#insertpredicate "Direct link to insertPredicate()?")

> `optional` **insertPredicate**: (`self`, `child`) => `boolean`

The function that checks whether a child component can be inserted into a parent component.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### self[​](#self "Direct link to self")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

##### child[​](#child "Direct link to child")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

#### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

***

### key[​](#key-1 "Direct link to key")

> `readonly` **key**: `string`

The component property key.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`key`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#key)

***

### localizable[​](#localizable "Direct link to localizable")

> `readonly` **localizable**: `boolean` = `false`

True if the property value can be localized, false otherwise.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`localizable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#localizable)

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

The component property name.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`name`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#name)

***

### readOnly[​](#readonly "Direct link to readOnly")

> `readonly` **readOnly**: `boolean` = `false`

True if the property value controls a read-only flag, false otherwise.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`readOnly`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#readonly)

***

### required[​](#required "Direct link to required")

> `readonly` **required**: `boolean` = `false`

True if the component property is required, false otherwise.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#required)

***

### slotConditionBuilder()?[​](#slotconditionbuilder "Direct link to slotConditionBuilder()?")

> `readonly` `optional` **slotConditionBuilder**: (`props`) => `string`

A function that returns a string containing the source code of the function to bind child components.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the properties of the component, which are available only inside Form Builder Designer.

#### Returns[​](#returns-2 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`slotConditionBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#slotconditionbuilder)

***

### type?[​](#type "Direct link to type?")

> `readonly` `optional` **type**: keyof SchemaTypeMap

The data type for the value of the property.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`type`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#type)

***

### uncontrolledValue?[​](#uncontrolledvalue "Direct link to uncontrolledValue?")

> `readonly` `optional` **uncontrolledValue**: `unknown`

The property value for the uncontrolled state.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#uncontrolledvalue)

***

### validator?[​](#validator "Direct link to validator?")

> `readonly` `optional` **validator**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The function for validating the property value.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`validator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#validator)

***

### valued[​](#valued "Direct link to valued")

> `readonly` **valued**: `boolean` = `false`

True if the property value is bound to form data, false otherwise.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#valued)

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `any`

#### Returns[​](#returns-3 "Direct link to Returns")

`any`

the metadata clone.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#clone)

***

### getNodeEditorType()[​](#getnodeeditortype "Direct link to getNodeEditorType()")

> **getNodeEditorType**(`componentProperty?`): [`NodeEditorType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType)

Returns the node editor type for the component property.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### componentProperty?[​](#componentproperty "Direct link to componentProperty?")

[`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)<`any`>

the component property.

#### Returns[​](#returns-4 "Direct link to Returns")

[`NodeEditorType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType)

the node editor type for the component property.


---

# Class: DataValidator

Binds all parts of the validation and performs the validation.

## Methods[​](#methods "Direct link to Methods")

### getValidationResult()[​](#getvalidationresult "Direct link to getValidationResult()")

> **getValidationResult**(`value`): `Promise`<`undefined` | `string`\[]>

Returns the validation results without triggering an events and changing the state of the form.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the validated value.

#### Returns[​](#returns "Direct link to Returns")

`Promise`<`undefined` | `string`\[]>

the validation results.

***

### sendValidationEvent()[​](#sendvalidationevent "Direct link to sendValidationEvent()")

> **sendValidationEvent**(`value`): `void`

Generates an event to perform validation.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`any`

the validated value.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### validate()[​](#validate "Direct link to validate()")

> **validate**(`value`): `Promise`<`undefined` | `string`>

Performs a validation of the value.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

the validated value.

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<`undefined` | `string`>

the Promise with the result of the validation.

***

### create()[​](#create "Direct link to create()")

> `static` **create**<`T`>(`store`, `getFormData`, `resolver`, `args`, `setter`, `localizer?`): `DataValidator`

Creates a DataValidator instance.

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

##### T[​](#t "Direct link to T")

`T`

the validation function factory arguments.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### store[​](#store "Direct link to store")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)

the form viewer settings.

##### getFormData[​](#getformdata "Direct link to getFormData")

() => [`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the function that returns a form data.

##### resolver[​](#resolver "Direct link to resolver")

[`SchemaResolver`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaResolver)<`T`>

the validation function factory.

##### args[​](#args "Direct link to args")

`T`

the validation function factory arguments.

##### setter[​](#setter "Direct link to setter")

[`Setter`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Setter)<`undefined` | `string`>

the callback function called to set a validation error.

##### localizer?[​](#localizer "Direct link to localizer?")

[`ErrorMessageLocalizer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMessageLocalizer)

the function that localizes validation error messages.

#### Returns[​](#returns-3 "Direct link to Returns")

`DataValidator`

the DataValidator instance.


---

# Class: EventAnnotation

Metadata for the component event property for the form builder.

## Extends[​](#extends "Direct link to Extends")

* [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new EventAnnotation**(`key`, `name`): `EventAnnotation`

Creates metadata for a React component property.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the property name.

##### name[​](#name "Direct link to name")

`string`

the human-readable property name.

#### Returns[​](#returns "Direct link to Returns")

`EventAnnotation`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#constructor)

## Properties[​](#properties "Direct link to Properties")

### bindingType?[​](#bindingtype "Direct link to bindingType?")

> `readonly` `optional` **bindingType**: [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)

The component property binding type.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`bindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#bindingtype)

***

### calculable[​](#calculable "Direct link to calculable")

> `readonly` **calculable**: `boolean` = `true`

True if the property value can be a calculated property, false otherwise.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#calculable)

***

### controlsRequiredProp[​](#controlsrequiredprop "Direct link to controlsRequiredProp")

> `readonly` **controlsRequiredProp**: `boolean` = `false`

True if the property value controls a required flag, false otherwise.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`controlsRequiredProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#controlsrequiredprop)

***

### dataBindingType[​](#databindingtype "Direct link to dataBindingType")

> `readonly` **dataBindingType**: [`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

The type of component data binding.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`dataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#databindingtype)

***

### default?[​](#default "Direct link to default?")

> `readonly` `optional` **default**: `any`

The default property value.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#default)

***

### disabled[​](#disabled "Direct link to disabled")

> `readonly` **disabled**: `boolean` = `false`

True if the property value controls a disabled flag, false otherwise.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`disabled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#disabled)

***

### editor[​](#editor "Direct link to editor")

> `readonly` **editor**: `string`

The name of the component's property editor.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editor)

***

### editorProps?[​](#editorprops "Direct link to editorProps?")

> `readonly` `optional` **editorProps**: `any`

Additional properties for the component property editor.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editorprops)

***

### errorMap?[​](#errormap "Direct link to errorMap?")

> `readonly` `optional` **errorMap**: [`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

Message and/or error code for the validation function.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`errorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#errormap)

***

### hint?[​](#hint "Direct link to hint?")

> `readonly` `optional` **hint**: `ReactNode`

The hint for the component property.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`hint`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#hint)

***

### key[​](#key-1 "Direct link to key")

> `readonly` **key**: `string`

The component property key.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`key`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#key)

***

### localizable[​](#localizable "Direct link to localizable")

> `readonly` **localizable**: `boolean` = `false`

True if the property value can be localized, false otherwise.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`localizable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#localizable)

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

The component property name.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`name`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#name)

***

### readOnly[​](#readonly "Direct link to readOnly")

> `readonly` **readOnly**: `boolean` = `false`

True if the property value controls a read-only flag, false otherwise.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`readOnly`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#readonly)

***

### required[​](#required "Direct link to required")

> `readonly` **required**: `boolean` = `false`

True if the component property is required, false otherwise.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#required)

***

### slotConditionBuilder()?[​](#slotconditionbuilder "Direct link to slotConditionBuilder()?")

> `readonly` `optional` **slotConditionBuilder**: (`props`) => `string`

A function that returns a string containing the source code of the function to bind child components.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the properties of the component, which are available only inside Form Builder Designer.

#### Returns[​](#returns-1 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`slotConditionBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#slotconditionbuilder)

***

### type?[​](#type "Direct link to type?")

> `readonly` `optional` **type**: keyof SchemaTypeMap

The data type for the value of the property.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`type`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#type)

***

### uncontrolledValue?[​](#uncontrolledvalue "Direct link to uncontrolledValue?")

> `readonly` `optional` **uncontrolledValue**: `unknown`

The property value for the uncontrolled state.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#uncontrolledvalue)

***

### validator?[​](#validator "Direct link to validator?")

> `readonly` `optional` **validator**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The function for validating the property value.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`validator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#validator)

***

### valued[​](#valued "Direct link to valued")

> `readonly` **valued**: `boolean` = `false`

True if the property value is bound to form data, false otherwise.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#valued)

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `any`

#### Returns[​](#returns-2 "Direct link to Returns")

`any`

the metadata clone.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#clone)


---

# Class: FluentLocalizationEngine

Fluent.js implementation of [ILocalizationEngine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).

## Implements[​](#implements "Direct link to Implements")

* [`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new FluentLocalizationEngine**(`locale?`): `FluentLocalizationEngine`

Constructor.

#### Parameters[​](#parameters "Direct link to Parameters")

##### locale?[​](#locale "Direct link to locale?")

`` `${string}-${string}` ``

the language full code, i.e. 'en-US'.

#### Returns[​](#returns "Direct link to Returns")

`FluentLocalizationEngine`

## Accessors[​](#accessors "Direct link to Accessors")

### language[​](#language "Direct link to language")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **language**(): `` `${string}-${string}` ``

The current language.

##### Returns[​](#returns-1 "Direct link to Returns")

`` `${string}-${string}` ``

#### Set Signature[​](#set-signature "Direct link to Set Signature")

> **set** **language**(`locale`): `void`

The current language.

##### Parameters[​](#parameters-1 "Direct link to Parameters")

###### locale[​](#locale-1 "Direct link to locale")

`` `${string}-${string}` ``

##### Returns[​](#returns-2 "Direct link to Returns")

`void`

The current language.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#language)

## Methods[​](#methods "Direct link to Methods")

### addMessages()[​](#addmessages "Direct link to addMessages()")

> **addMessages**(`locale`, `messages`): [`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

Adds messages to the localization engine.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### locale[​](#locale-2 "Direct link to locale")

`` `${string}-${string}` ``

the locale for the messages.

##### messages[​](#messages "Direct link to messages")

`Record`<`string`, `string`>

the messages to add.

#### Returns[​](#returns-3 "Direct link to Returns")

[`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

the array of any localization errors that occurred.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`addMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#addmessages)

***

### getCompatibleId()[​](#getcompatibleid "Direct link to getCompatibleId()")

> **getCompatibleId**(`rawId`): `string`

Gets a compatible ID for localization engine.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### rawId[​](#rawid "Direct link to rawId")

`string`

the raw ID to make compatible.

#### Returns[​](#returns-4 "Direct link to Returns")

`string`

the compatible ID.

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`getCompatibleId`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#getcompatibleid)

***

### localizeErrorMessage()[​](#localizeerrormessage "Direct link to localizeErrorMessage()")

> **localizeErrorMessage**(`form`, `formData`, `language`, `componentStore`, `ruleKey`): `undefined` | `string`

Localizes error messages for validation rules.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### form[​](#form "Direct link to form")

[`IForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm)

the form containing localization data.

##### formData[​](#formdata "Direct link to formData")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the form data for variable substitution.

##### language[​](#language-1 "Direct link to language")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the target language for localization.

##### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component store to localize.

##### ruleKey[​](#rulekey "Direct link to ruleKey")

`string`

the validation rule key.

#### Returns[​](#returns-5 "Direct link to Returns")

`undefined` | `string`

the localized error message or undefined.

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`localizeErrorMessage`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#localizeerrormessage)

***

### localizeProperties()[​](#localizeproperties "Direct link to localizeProperties()")

> **localizeProperties**(`form`, `formData`, `language`, `componentStore`, `type`): `Record`<`string`, `any`>

Localizes properties for a component.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### form[​](#form-1 "Direct link to form")

[`IForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm)

the form containing localization data.

##### formData[​](#formdata-1 "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data for variable substitution.

##### language[​](#language-2 "Direct link to language")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the target language for localization.

##### componentStore[​](#componentstore-1 "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component store to localize.

##### type[​](#type "Direct link to type")

`string` = `'component'`

the type of localization (default: 'component').

#### Returns[​](#returns-6 "Direct link to Returns")

`Record`<`string`, `any`>

the object with localized property values.

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`localizeProperties`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#localizeproperties)

***

### testLocalization()[​](#testlocalization "Direct link to testLocalization()")

> **testLocalization**(`localization`, `localizationStringId`, `language`, `formData`): `string` | [`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### localization[​](#localization "Direct link to localization")

`string`

the localization string to test.

##### localizationStringId[​](#localizationstringid "Direct link to localizationStringId")

`string`

the ID of the localization string.

##### language[​](#language-3 "Direct link to language")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the language for the test.

##### formData[​](#formdata-2 "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the data to use for variable substitution.

#### Returns[​](#returns-7 "Direct link to Returns")

`string` | [`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

the array of errors or the formatted result string.

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`testLocalization`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#testlocalization)


---

# Class: Form

Represents a form that is rendered in Viewer or edited in Builder.

## Implements[​](#implements "Direct link to Implements")

* [`IForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new Form**(`componentTree`, `localization`, `actions`, `languages`, `defaultLanguage`): `Form`

Creates a new instance of Form.

#### Parameters[​](#parameters "Direct link to Parameters")

##### componentTree[​](#componenttree "Direct link to componentTree")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the root component of the form.

##### localization[​](#localization "Direct link to localization")

[`LocalizationStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/LocalizationStore)

the localization of the form.

##### actions[​](#actions "Direct link to actions")

[`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

the form custom actions.

##### languages[​](#languages "Direct link to languages")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)\[]

the localization languages of the form.

##### defaultLanguage[​](#defaultlanguage "Direct link to defaultLanguage")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the default localization language of the form.

#### Returns[​](#returns "Direct link to Returns")

`Form`

## Properties[​](#properties "Direct link to Properties")

### actions[​](#actions-1 "Direct link to actions")

> `readonly` **actions**: [`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

The set of action definitions.

***

### componentTree[​](#componenttree-1 "Direct link to componentTree")

> `readonly` **componentTree**: [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

Root component of the form.

***

### defaultLanguage[​](#defaultlanguage-1 "Direct link to defaultLanguage")

> **defaultLanguage**: [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

Default localization language of the form.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm).[`defaultLanguage`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm#defaultlanguage)

***

### errorProps[​](#errorprops "Direct link to errorProps")

> **errorProps**: `any` = `{}`

Properties of the component displaying the error.

***

### errorType?[​](#errortype "Direct link to errorType?")

> `optional` **errorType**: `string`

The type name of the component displaying the error.

***

### formValidator?[​](#formvalidator "Direct link to formValidator?")

> `optional` **formValidator**: `string`

The form validator.

***

### languages[​](#languages-1 "Direct link to languages")

> `readonly` **languages**: [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)\[] = `[]`

Localization languages of the form.

***

### localization[​](#localization-1 "Direct link to localization")

> `readonly` **localization**: [`LocalizationStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/LocalizationStore)

Localization of the form.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm).[`localization`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm#localization)

***

### modalType?[​](#modaltype "Direct link to modalType?")

> `optional` **modalType**: `string`

The type name of the component displaying the modal.

***

### tooltipType?[​](#tooltiptype "Direct link to tooltipType?")

> `optional` **tooltipType**: `string`

The type name of the component displaying the tooltip.

## Accessors[​](#accessors "Direct link to Accessors")

### actionNames[​](#actionnames "Direct link to actionNames")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **actionNames**(): `string`\[]

##### Returns[​](#returns-1 "Direct link to Returns")

`string`\[]

the actions names array.

***

### formValidatorFunction[​](#formvalidatorfunction "Direct link to formValidatorFunction")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **formValidatorFunction**(): `undefined` | [`FormValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidator)

##### Returns[​](#returns-2 "Direct link to Returns")

`undefined` | [`FormValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidator)

the form validator function.

## Methods[​](#methods "Direct link to Methods")

### cloneAction()[​](#cloneaction "Direct link to cloneAction()")

> **cloneAction**(`namedAction`): `void`

Clones the action.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### namedAction[​](#namedaction "Direct link to namedAction")

[`NamedActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NamedActionDefinition)

the named action to clone.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**(): `void`

Disposes the form. Disposes all the components and localization.

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

***

### initFields()[​](#initfields "Direct link to initFields()")

> **initFields**(): `void`

Initializes form fields.

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

***

### removeAction()[​](#removeaction "Direct link to removeAction()")

> **removeAction**(`name`): `void`

Removes the action from the form.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the action name to remove.

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

***

### updateOrAddAction()[​](#updateoraddaction "Direct link to updateOrAddAction()")

> **updateOrAddAction**(`oldActionName`, `newAction`): `void`

Changes the existing action to the new one, adds the action if the existing action is not found.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### oldActionName[​](#oldactionname "Direct link to oldActionName")

`string`

the existing action name.

##### newAction[​](#newaction "Direct link to newAction")

[`NamedActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NamedActionDefinition)

the new named action.

#### Returns[​](#returns-7 "Direct link to Returns")

`void`


---

# Class: FormViewerPropsStore

Represents the props passed to the FormViewer Store. **Internal use only.**

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new FormViewerPropsStore**(`formViewerProps`): `FormViewerPropsStore`

Constructs a new FormViewerPropsStore from the given FormViewerProps.

#### Parameters[​](#parameters "Direct link to Parameters")

##### formViewerProps[​](#formviewerprops "Direct link to formViewerProps")

[`FormViewerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps)

the FormViewer props.

#### Returns[​](#returns "Direct link to Returns")

`FormViewerPropsStore`

the FormViewerPropsStore.

## Properties[​](#properties "Direct link to Properties")

### actions?[​](#actions "Direct link to actions?")

> `optional` **actions**: [`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

Custom actions for the form viewer.

***

### context?[​](#context "Direct link to context?")

> `optional` **context**: `any`

The arbitrary user context.

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the form is disabled.

***

### errorWrapper?[​](#errorwrapper "Direct link to errorWrapper?")

> `optional` **errorWrapper**: `ComponentType`<[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)>

The default error wrapper used when errorType is not specified in the form.

***

### formValidators?[​](#formvalidators "Direct link to formValidators?")

> `optional` **formValidators**: [`FormValidators`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidators)

The set of functions that validate the form data.

***

### initialData[​](#initialdata "Direct link to initialData")

> **initialData**: `Record`<`string`, `unknown`> = `{}`

The initial form data.

***

### localizationEngine?[​](#localizationengine "Direct link to localizationEngine?")

> `optional` **localizationEngine**: [`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine)

The localization engine provided via FormViewer props.

***

### localizer?[​](#localizer "Direct link to localizer?")

> `optional` **localizer**: [`ComponentLocalizer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLocalizer)

The function to localize the properties of a component.

***

### propsLanguage?[​](#propslanguage "Direct link to propsLanguage?")

> `optional` **propsLanguage**: `` `${string}-${string}` ``

The full language code passed in the FormViewer properties, e.g. 'en-US'.

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the form is read-only.

***

### showAllValidationErrors?[​](#showallvalidationerrors "Direct link to showAllValidationErrors?")

> `optional` **showAllValidationErrors**: `boolean`

If true, all validation errors will be displayed.

***

### validators?[​](#validators "Direct link to validators?")

> `optional` **validators**: `Partial`<`Record`\<keyof [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap), [`CustomValidationRules`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRules)>>

The set of metadata of validation rules, grouped by the type of value being validated.

***

### view[​](#view "Direct link to view")

> **view**: [`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView)

The metadata of the form viewer components.

## Methods[​](#methods "Direct link to Methods")

### applyProps()[​](#applyprops "Direct link to applyProps()")

> **applyProps**(`formViewerProps`): `void`

Applies the given FormViewerProps.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### formViewerProps[​](#formviewerprops-1 "Direct link to formViewerProps")

[`FormViewerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps)

the properties to apply.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `FormViewerPropsStore`

Returns the clone of the FormViewerPropsStore object.

#### Returns[​](#returns-2 "Direct link to Returns")

`FormViewerPropsStore`

the clone of the FormViewerPropsStore object.


---

# Class: Language

The language to localize the form builder.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new Language**(`code`, `dialect`, `name`, `description`, `bidi`): `Language`

Creates a localization language for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### code[​](#code "Direct link to code")

`string`

the language code, for example, 'en'.

##### dialect[​](#dialect "Direct link to dialect")

`string`

the dialect code, for example, 'US'.

##### name[​](#name "Direct link to name")

`string`

the name of the language, for example 'English'.

##### description[​](#description "Direct link to description")

`string`

the description of the language, for example 'American English'.

##### bidi[​](#bidi "Direct link to bidi")

[`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi) = `BiDi.LTR`

the type of text layout, for example, BiDi.LTR.

#### Returns[​](#returns "Direct link to Returns")

`Language`

## Properties[​](#properties "Direct link to Properties")

### bidi[​](#bidi-1 "Direct link to bidi")

> `readonly` **bidi**: [`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi) = `BiDi.LTR`

the type of text layout, for example, BiDi.LTR.

***

### code[​](#code-1 "Direct link to code")

> `readonly` **code**: `string`

the language code, for example, 'en'.

***

### description[​](#description-1 "Direct link to description")

> `readonly` **description**: `string`

the description of the language, for example 'American English'.

***

### dialect[​](#dialect-1 "Direct link to dialect")

> `readonly` **dialect**: `string`

the dialect code, for example, 'US'.

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

the name of the language, for example 'English'.

## Accessors[​](#accessors "Direct link to Accessors")

### fullCode[​](#fullcode "Direct link to fullCode")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **fullCode**(): `` `${string}-${string}` ``

##### Returns[​](#returns-1 "Direct link to Returns")

`` `${string}-${string}` ``

the full code of the Language i.e. en-US, en-GB etc.

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> `static` **clone**(`source`): `Language`

Clones an existing instance of the language.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### source[​](#source "Direct link to source")

`Language`

the cloning object.

#### Returns[​](#returns-2 "Direct link to Returns")

`Language`

the object clone.


---

# Class: LocalizationStore

Observable storage of localization. **Internal use only.**

## Implements[​](#implements "Direct link to Implements")

* [`ILocalizationStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationStore)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new LocalizationStore**(`value`, `engine`): `LocalizationStore`

Creates a new LocalizationStore instance.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

[`LocalizationValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue) = `{}`

the initial localization value.

##### engine[​](#engine "Direct link to engine")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine)

the localization engine to use.

#### Returns[​](#returns "Direct link to Returns")

`LocalizationStore`

## Properties[​](#properties "Direct link to Properties")

### engine[​](#engine-1 "Direct link to engine")

> `readonly` **engine**: [`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine)

the localization engine to use.

***

### value[​](#value-1 "Direct link to value")

> `readonly` **value**: [`LocalizationValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue) = `{}`

the initial localization value.

## Accessors[​](#accessors "Direct link to Accessors")

### langCodes[​](#langcodes "Direct link to langCodes")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **langCodes**(): `` `${string}-${string}` ``\[]

##### Returns[​](#returns-1 "Direct link to Returns")

`` `${string}-${string}` ``\[]

the available language codes.

## Methods[​](#methods "Direct link to Methods")

### addLocalizationWithNewKey()[​](#addlocalizationwithnewkey "Direct link to addLocalizationWithNewKey()")

> **addLocalizationWithNewKey**(`localization`, `oldComponentKey`, `newComponentKey`): `void`

Inserts the localization values for a given component key. Replaces the old component key with the new component key.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### localization[​](#localization "Direct link to localization")

[`LocalizationValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue)

the localization object for insertion.

##### oldComponentKey[​](#oldcomponentkey "Direct link to oldComponentKey")

`string`

the old component key that needs to be replaced.

##### newComponentKey[​](#newcomponentkey "Direct link to newComponentKey")

`string`

the new component key to be added.

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

***

### changeComponentKey()[​](#changecomponentkey "Direct link to changeComponentKey()")

> **changeComponentKey**(`oldComponentKey`, `newComponentKey`): `void`

Changes the component key for all languages in the value object.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### oldComponentKey[​](#oldcomponentkey-1 "Direct link to oldComponentKey")

`string`

the old component key to be replaced.

##### newComponentKey[​](#newcomponentkey-1 "Direct link to newComponentKey")

`string`

the new component key to replace the old component key.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### findLocalizationKey()[​](#findlocalizationkey "Direct link to findLocalizationKey()")

> **findLocalizationKey**(`languageFullCode`): `null` | `` `${string}-${string}` ``

Finds the best matching localization key for the given language code. Looks for exact match first, then match by language code only.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### languageFullCode[​](#languagefullcode "Direct link to languageFullCode")

`` `${string}-${string}` ``

the requested language full code.

#### Returns[​](#returns-4 "Direct link to Returns")

`null` | `` `${string}-${string}` ``

the best matching language full code or null if no match found.

***

### getItems()[​](#getitems "Direct link to getItems()")

> **getItems**(`languageFullCode`): `null` | `Record`<`string`, `string`>

Returns all localization items provided by engine.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### languageFullCode[​](#languagefullcode-1 "Direct link to languageFullCode")

`` `${string}-${string}` ``

the full code (en-US, en-GB etc.).

#### Returns[​](#returns-5 "Direct link to Returns")

`null` | `Record`<`string`, `string`>

all localization items.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILocalizationStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationStore).[`getItems`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationStore#getitems)

***

### getLocalization()[​](#getlocalization "Direct link to getLocalization()")

> **getLocalization**(`languageFullCode`, `componentKey`, `propertyName`, `type`): `undefined` | `string`

Returns value of localization constant.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### languageFullCode[​](#languagefullcode-2 "Direct link to languageFullCode")

`` `${string}-${string}` ``

the full code (en-US, en-GB etc.) of the language we are looking to localize.

##### componentKey[​](#componentkey "Direct link to componentKey")

`string`

the component we are looking to localize.

##### propertyName[​](#propertyname "Direct link to propertyName")

`string`

the property name we are looking to localize.

##### type[​](#type "Direct link to type")

`string`

the type of localization.

#### Returns[​](#returns-6 "Direct link to Returns")

`undefined` | `string`

the value of localization constant.

***

### getLocalizationForComponent()[​](#getlocalizationforcomponent "Direct link to getLocalizationForComponent()")

> **getLocalizationForComponent**(`componentKey`): [`LocalizationValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue)

Retrieves the localization values for a given component key.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### componentKey[​](#componentkey-1 "Direct link to componentKey")

`string`

the key of the component to retrieve localization for.

#### Returns[​](#returns-7 "Direct link to Returns")

[`LocalizationValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue)

the object containing the localization values for the component in each supported language.

***

### hasLanguage()[​](#haslanguage "Direct link to hasLanguage()")

> **hasLanguage**(`languageFullCode`): `boolean`

Checks that the specified language exists in the localization. Looks for exact match first, then match by language code only.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### languageFullCode[​](#languagefullcode-3 "Direct link to languageFullCode")

`` `${string}-${string}` ``

The full code (en-US, en-GB etc.) of the language to be checked.

#### Returns[​](#returns-8 "Direct link to Returns")

`boolean`

true if the specified language exists in the localization.

***

### hasLocalization()[​](#haslocalization "Direct link to hasLocalization()")

> **hasLocalization**(`componentKey`, `propertyName`, `type`): `boolean`

Checks that the specified property has localization.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### componentKey[​](#componentkey-2 "Direct link to componentKey")

`string`

the component we are looking to localize.

##### propertyName[​](#propertyname-1 "Direct link to propertyName")

`string`

the component's property name to be localized.

##### type[​](#type-1 "Direct link to type")

`string`

the type of localization.

#### Returns[​](#returns-9 "Direct link to Returns")

`boolean`

true if the specified property has localization in at least one language.

***

### removeLocalization()[​](#removelocalization "Direct link to removeLocalization()")

> **removeLocalization**(`componentKey`): `void`

Removes localization for component.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### componentKey[​](#componentkey-3 "Direct link to componentKey")

`string`

the component key that requires localization removal.

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

***

### removeLocalizationForType()[​](#removelocalizationfortype "Direct link to removeLocalizationForType()")

> **removeLocalizationForType**(`componentKey`, `type`): `void`

Removes localization for component with specified type.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### componentKey[​](#componentkey-4 "Direct link to componentKey")

`string`

the component key that requires localization removal.

##### type[​](#type-2 "Direct link to type")

`string`

the localization type.

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

***

### setLocalization()[​](#setlocalization "Direct link to setLocalization()")

> **setLocalization**(`languageFullCode`, `componentKey`, `propertyName`, `type`, `value`): `void`

Sets localization for component property.

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### languageFullCode[​](#languagefullcode-4 "Direct link to languageFullCode")

`` `${string}-${string}` ``

the full code (en-US, en-GB etc.) of the language in which localization will be set.

##### componentKey[​](#componentkey-5 "Direct link to componentKey")

`string`

the component key that requires localization.

##### propertyName[​](#propertyname-2 "Direct link to propertyName")

`string`

the component's property name to be localized.

##### type[​](#type-3 "Direct link to type")

`string`

the type of localization.

##### value[​](#value-2 "Direct link to value")

`string`

the localization value.

#### Returns[​](#returns-12 "Direct link to Returns")

`void`


---

# Class: Meta

Component metadata for the form builder.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new Meta**(`type`, `properties`, `css`, `wrapperCss`, `modules`, `customPreview?`, `valuedAn?`, `initialJson?`, `eventListeners?`, `icon?`, `insertRestriction?`): `Meta`

Creates the component metadata for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`string`

the component type name.

##### properties[​](#properties "Direct link to properties")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the component's properties metadata.

##### css[​](#css "Direct link to css")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the component's CSS metadata.

##### wrapperCss[​](#wrappercss "Direct link to wrapperCss")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the component's wrapper CSS metadata.

##### modules[​](#modules "Direct link to modules")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

common metadata for the component.

##### customPreview?[​](#custompreview "Direct link to customPreview?")

`ReactNode`

the custom ReactNode to be drawn on the toolbar.

##### valuedAn?[​](#valuedan "Direct link to valuedAn?")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the metadata for the component value.

##### initialJson?[​](#initialjson "Direct link to initialJson?")

`string`

the JSON source for the component (instance of [ComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore) class serialised to JSON).

##### eventListeners?[​](#eventlisteners "Direct link to eventListeners?")

[`ComponentMetadataEventListeners`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners)

the component metadata event listeners.

##### icon?[​](#icon "Direct link to icon?")

the component icon or the icon name.

`string` | `ComponentType`

##### insertRestriction?[​](#insertrestriction "Direct link to insertRestriction?")

[`InsertRestrictionFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn)

the function that restricts the insertion of a component into another component.

#### Returns[​](#returns "Direct link to Returns")

`Meta`

## Properties[​](#properties-1 "Direct link to Properties")

### css[​](#css-1 "Direct link to css")

> `readonly` **css**: [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the component's CSS metadata.

***

### ~~customPreview?~~[​](#custompreview-1 "Direct link to custompreview-1")

> `readonly` `optional` **customPreview**: `ReactNode`

#### Deprecated[​](#deprecated "Direct link to Deprecated")

The custom ReactNode to be drawn on the toolbar.

***

### eventListeners?[​](#eventlisteners-1 "Direct link to eventListeners?")

> `readonly` `optional` **eventListeners**: [`ComponentMetadataEventListeners`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners)

the component metadata event listeners.

***

### icon?[​](#icon-1 "Direct link to icon?")

> `readonly` `optional` **icon**: `string` | `ComponentType`

the component icon or the icon name.

***

### initialJson?[​](#initialjson-1 "Direct link to initialJson?")

> `readonly` `optional` **initialJson**: `string`

the JSON source for the component (instance of [ComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore) class serialised to JSON).

***

### insertRestriction?[​](#insertrestriction-1 "Direct link to insertRestriction?")

> `readonly` `optional` **insertRestriction**: [`InsertRestrictionFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn)

the function that restricts the insertion of a component into another component.

***

### modules[​](#modules-1 "Direct link to modules")

> `readonly` **modules**: [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

common metadata for the component.

***

### properties[​](#properties-2 "Direct link to properties")

> `readonly` **properties**: [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the component's properties metadata.

***

### type[​](#type-1 "Direct link to type")

> `readonly` **type**: `string`

the component type name.

***

### valuedAn?[​](#valuedan-1 "Direct link to valuedAn?")

> `readonly` `optional` **valuedAn**: [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the metadata for the component value.

***

### wrapperCss[​](#wrappercss-1 "Direct link to wrapperCss")

> `readonly` **wrapperCss**: [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the component's wrapper CSS metadata.


---

# Class: Model\<T>

Represents component metadata for the form viewer.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` = `any`

the type of React component properties.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new Model**<`T`>(`component`, `name?`, `actionsInitializer?`, `valued?`, `valueType?`, `defaultProps?`, `css?`, `wrapperCss?`, `typeName?`, `kind?`, `readOnly?`, `propsBindingTypes?`, `uncontrolledValue?`, `disabled?`, `dataBindingType?`, `features?`): `Model`<`T`>

Creates component metadata for the form viewer.

#### Parameters[​](#parameters "Direct link to Parameters")

##### component[​](#component "Direct link to component")

`ComponentType`<`T`>

the React component.

##### name?[​](#name "Direct link to name?")

`string`

the component name.

##### actionsInitializer?[​](#actionsinitializer "Direct link to actionsInitializer?")

[`ActionsInitializer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionsInitializer)

the function to initialize actions in the component.

##### valued?[​](#valued "Direct link to valued?")

`string`

the name of the component property where the component value is stored.

##### valueType?[​](#valuetype "Direct link to valueType?")

keyof SchemaTypeMap

the type of the component value.

##### defaultProps?[​](#defaultprops "Direct link to defaultProps?")

`Readonly`<`Record`<`string`, `any`>>

the component's default property values.

##### css?[​](#css "Direct link to css?")

[`Css`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css)

the component's CSS values.

##### wrapperCss?[​](#wrappercss "Direct link to wrapperCss?")

[`Css`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css)

the component's wrapper CSS values.

##### typeName?[​](#typename "Direct link to typeName?")

`string`

the component type name.

##### kind?[​](#kind "Direct link to kind?")

[`ComponentKind`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKind) = `'component'`

the component kind.

##### readOnly?[​](#readonly "Direct link to readOnly?")

`string`

the name of the component property that stores the read-only flag.

##### propsBindingTypes?[​](#propsbindingtypes "Direct link to propsBindingTypes?")

`Readonly`<`Record`<`string`, [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)>> = `{}`

the component property binding types.

##### uncontrolledValue?[​](#uncontrolledvalue "Direct link to uncontrolledValue?")

`unknown`

the value for the uncontrolled (undefined) state.

##### disabled?[​](#disabled "Direct link to disabled?")

`string`

the name of the component property that stores the disabled flag.

##### dataBindingType?[​](#databindingtype "Direct link to dataBindingType?")

[`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

the type of component data binding.

##### features?[​](#features "Direct link to features?")

[`ComponentFeatures`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeatures) = `{}`

the component features that provide additional information about component's characteristic.

#### Returns[​](#returns "Direct link to Returns")

`Model`<`T`>

## Properties[​](#properties "Direct link to Properties")

### actionsInitializer?[​](#actionsinitializer-1 "Direct link to actionsInitializer?")

> `readonly` `optional` **actionsInitializer**: [`ActionsInitializer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionsInitializer)

the function to initialize actions in the component.

***

### component[​](#component-1 "Direct link to component")

> `readonly` **component**: `ComponentType`<`T`>

The React component.

***

### css?[​](#css-1 "Direct link to css?")

> `readonly` `optional` **css**: [`Css`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css)

the component's CSS values.

***

### dataBindingType[​](#databindingtype-1 "Direct link to dataBindingType")

> `readonly` **dataBindingType**: [`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

the type of component data binding.

***

### defaultProps?[​](#defaultprops-1 "Direct link to defaultProps?")

> `readonly` `optional` **defaultProps**: `Readonly`<`Record`<`string`, `any`>>

the component's default property values.

***

### disabled?[​](#disabled-1 "Direct link to disabled?")

> `readonly` `optional` **disabled**: `string`

the name of the component property that stores the disabled flag.

***

### features[​](#features-1 "Direct link to features")

> `readonly` **features**: [`ComponentFeatures`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeatures) = `{}`

the component features that provide additional information about component's characteristic.

***

### kind[​](#kind-1 "Direct link to kind")

> `readonly` **kind**: [`ComponentKind`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKind) = `'component'`

the component kind.

***

### propsBindingTypes[​](#propsbindingtypes-1 "Direct link to propsBindingTypes")

> `readonly` **propsBindingTypes**: `Readonly`<`Record`<`string`, [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)>> = `{}`

the component property binding types.

***

### readOnly?[​](#readonly-1 "Direct link to readOnly?")

> `readonly` `optional` **readOnly**: `string`

the name of the component property that stores the read-only flag.

***

### typeName?[​](#typename-1 "Direct link to typeName?")

> `readonly` `optional` **typeName**: `string`

the component type name.

***

### uncontrolledValue?[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue?")

> `readonly` `optional` **uncontrolledValue**: `unknown`

the value for the uncontrolled (undefined) state.

***

### valued?[​](#valued-1 "Direct link to valued?")

> `readonly` `optional` **valued**: `string`

the name of the component property where the component value is stored.

***

### valueType?[​](#valuetype-1 "Direct link to valueType?")

> `readonly` `optional` **valueType**: keyof SchemaTypeMap

the type of the component value.

***

### wrapperCss?[​](#wrappercss-1 "Direct link to wrapperCss?")

> `readonly` `optional` **wrapperCss**: [`Css`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Css)

the component's wrapper CSS values.

## Accessors[​](#accessors "Direct link to Accessors")

### name[​](#name-1 "Direct link to name")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **name**(): `string`

##### Returns[​](#returns-1 "Direct link to Returns")

`string`

the component name, or type if there is no component name.

***

### type[​](#type "Direct link to type")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **type**(): `string`

##### Returns[​](#returns-2 "Direct link to Returns")

`string`

the component type name.

## Methods[​](#methods "Direct link to Methods")

### hasComponentRole()[​](#hascomponentrole "Direct link to hasComponentRole()")

> **hasComponentRole**(`value`): `boolean`

Returns true if the role is defined in the component's roles, false otherwise.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`string`

the component role.

#### Returns[​](#returns-3 "Direct link to Returns")

`boolean`

true if the role is defined in the component's roles, false otherwise.

***

### hasFeatureValue()[​](#hasfeaturevalue "Direct link to hasFeatureValue()")

> **hasFeatureValue**(`name`, `value`): `boolean`

Returns true if feature is present in the component feature set and equals value, false otherwise.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### name[​](#name-2 "Direct link to name")

`string`

the feature name.

##### value[​](#value-1 "Direct link to value")

`unknown`

the feature value.

#### Returns[​](#returns-4 "Direct link to Returns")

`boolean`

true if feature is present in the component feature set and equals value, false otherwise.

***

### isFeatureEnabled()[​](#isfeatureenabled "Direct link to isFeatureEnabled()")

> **isFeatureEnabled**(`name`): `boolean`

Returns true if feature is present in the component feature set and equals `true`, false otherwise.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### name[​](#name-3 "Direct link to name")

`string`

the feature name.

#### Returns[​](#returns-5 "Direct link to Returns")

`boolean`

true if feature is present in the component feature set and equals `true`, false otherwise.


---

# Class: ModuleAnnotation

Metadata for a component property that is not a property of the component itself, but is supplied by the form builder.

## Extends[​](#extends "Direct link to Extends")

* [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ModuleAnnotation**(`key`, `name`): `ModuleAnnotation`

Creates metadata for a React component property.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the property name.

##### name[​](#name "Direct link to name")

`string`

the human-readable property name.

#### Returns[​](#returns "Direct link to Returns")

`ModuleAnnotation`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#constructor)

## Properties[​](#properties "Direct link to Properties")

### bindingType?[​](#bindingtype "Direct link to bindingType?")

> `readonly` `optional` **bindingType**: [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)

The component property binding type.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`bindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#bindingtype)

***

### calculable[​](#calculable "Direct link to calculable")

> `readonly` **calculable**: `boolean` = `true`

True if the property value can be a calculated property, false otherwise.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#calculable)

***

### controlsRequiredProp[​](#controlsrequiredprop "Direct link to controlsRequiredProp")

> `readonly` **controlsRequiredProp**: `boolean` = `false`

True if the property value controls a required flag, false otherwise.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`controlsRequiredProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#controlsrequiredprop)

***

### dataBindingType[​](#databindingtype "Direct link to dataBindingType")

> `readonly` **dataBindingType**: [`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

The type of component data binding.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`dataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#databindingtype)

***

### default?[​](#default "Direct link to default?")

> `readonly` `optional` **default**: `any`

The default property value.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#default)

***

### disabled[​](#disabled "Direct link to disabled")

> `readonly` **disabled**: `boolean` = `false`

True if the property value controls a disabled flag, false otherwise.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`disabled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#disabled)

***

### editor[​](#editor "Direct link to editor")

> `readonly` **editor**: `string`

The name of the component's property editor.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editor)

***

### editorProps?[​](#editorprops "Direct link to editorProps?")

> `readonly` `optional` **editorProps**: `any`

Additional properties for the component property editor.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editorprops)

***

### errorMap?[​](#errormap "Direct link to errorMap?")

> `readonly` `optional` **errorMap**: [`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

Message and/or error code for the validation function.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`errorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#errormap)

***

### hint?[​](#hint "Direct link to hint?")

> `readonly` `optional` **hint**: `ReactNode`

The hint for the component property.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`hint`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#hint)

***

### key[​](#key-1 "Direct link to key")

> `readonly` **key**: `string`

The component property key.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`key`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#key)

***

### localizable[​](#localizable "Direct link to localizable")

> `readonly` **localizable**: `boolean` = `false`

True if the property value can be localized, false otherwise.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`localizable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#localizable)

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

The component property name.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`name`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#name)

***

### readOnly[​](#readonly "Direct link to readOnly")

> `readonly` **readOnly**: `boolean` = `false`

True if the property value controls a read-only flag, false otherwise.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`readOnly`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#readonly)

***

### required[​](#required "Direct link to required")

> `readonly` **required**: `boolean` = `false`

True if the component property is required, false otherwise.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#required)

***

### slotConditionBuilder()?[​](#slotconditionbuilder "Direct link to slotConditionBuilder()?")

> `readonly` `optional` **slotConditionBuilder**: (`props`) => `string`

A function that returns a string containing the source code of the function to bind child components.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the properties of the component, which are available only inside Form Builder Designer.

#### Returns[​](#returns-1 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`slotConditionBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#slotconditionbuilder)

***

### type?[​](#type "Direct link to type?")

> `readonly` `optional` **type**: keyof SchemaTypeMap

The data type for the value of the property.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`type`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#type)

***

### uncontrolledValue?[​](#uncontrolledvalue "Direct link to uncontrolledValue?")

> `readonly` `optional` **uncontrolledValue**: `unknown`

The property value for the uncontrolled state.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#uncontrolledvalue)

***

### validator?[​](#validator "Direct link to validator?")

> `readonly` `optional` **validator**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The function for validating the property value.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`validator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#validator)

***

### valued[​](#valued "Direct link to valued")

> `readonly` **valued**: `boolean` = `false`

True if the property value is bound to form data, false otherwise.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#valued)

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `any`

#### Returns[​](#returns-2 "Direct link to Returns")

`any`

the metadata clone.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#clone)


---

# Class: NodeAnnotationBuilder\<T>

The builder class to define the node metadata property.

## Extends[​](#extends "Direct link to Extends")

* [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`T`>

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new NodeAnnotationBuilder**<`T`>(`editor`): `NodeAnnotationBuilder`<`T`>

Creates a component property metadata builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### editor[​](#editor "Direct link to editor")

`string`

the property editor type.

#### Returns[​](#returns "Direct link to Returns")

`NodeAnnotationBuilder`<`T`>

#### Overrides[​](#overrides "Direct link to Overrides")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#constructor)

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#annotation)

***

### defaultEditor?[​](#defaulteditor "Direct link to defaultEditor?")

> `optional` **defaultEditor**: [`NodeEditorType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType)

The default editor.

***

### insertPredicate()?[​](#insertpredicate "Direct link to insertPredicate()?")

> `optional` **insertPredicate**: (`self`, `child`) => `boolean`

The function that checks whether a child component can be inserted into a parent component.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### self[​](#self "Direct link to self")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

##### child[​](#child "Direct link to child")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

#### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`options`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#options)

## Accessors[​](#accessors "Direct link to Accessors")

### array[​](#array "Direct link to array")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **array**(): [`ArrayBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder)<`undefined` | `T`\[]>

Sets the property as a "array" property.

##### Returns[​](#returns-2 "Direct link to Returns")

[`ArrayBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder)<`undefined` | `T`\[]>

the instance of the metadata property builder.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`array`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#array)

***

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`dataBound`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#databound)

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-4 "Direct link to Returns")

`this`

the component property that can be localized.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`localize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#localize)

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-5 "Direct link to Returns")

`this`

the non-localizable component property.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`notLocalize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#notlocalize)

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-6 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#valued)

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-7 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`build`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#build)

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `NodeAnnotationBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-8 "Direct link to Returns")

`NodeAnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#calculable)

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-9 "Direct link to Returns")

`this`

the cloned instance of the builder.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#clone)

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-10 "Direct link to Returns")

`string`

the annotation name.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`getName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#getname)

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-11 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`hideEditor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#hideeditor)

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `NodeAnnotationBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-12 "Direct link to Returns")

`NodeAnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`hinted`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#hinted)

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `NodeAnnotationBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-13 "Direct link to Returns")

`NodeAnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`named`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#named)

***

### oneOf()[​](#oneof "Direct link to oneOf()")

> **oneOf**<`U`>(...`values`): [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

Sets the property as a "single select" property.

#### Type Parameters[​](#type-parameters-1 "Direct link to Type Parameters")

##### U[​](#u "Direct link to U")

`U` *extends* `string` | `number`

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### values[​](#values "Direct link to values")

...`U`\[]

the possible values for the property.

#### Returns[​](#returns-14 "Direct link to Returns")

[`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

the instance of the metadata property builder.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`oneOf`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#oneof)

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-15 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`setup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#setup)

***

### someOf()[​](#someof "Direct link to someOf()")

> **someOf**<`U`>(...`values`): [`SomeOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)<`U`>

Sets the property as a "multiple select" property.

#### Type Parameters[​](#type-parameters-2 "Direct link to Type Parameters")

##### U[​](#u-1 "Direct link to U")

`U` *extends* `string` | `number`

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### values[​](#values-1 "Direct link to values")

...`U`\[]

the possible values for the property.

#### Returns[​](#returns-16 "Direct link to Returns")

[`SomeOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)<`U`>

the instance of the metadata property builder.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`someOf`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#someof)

***

### typed()[​](#typed "Direct link to typed()")

> **typed**<`T`>(`type`): [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)\[`T`]>

Sets the field type for the component property.

#### Type Parameters[​](#type-parameters-3 "Direct link to Type Parameters")

##### T[​](#t-1 "Direct link to T")

`T` *extends* keyof [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`T`

the field type.

#### Returns[​](#returns-17 "Direct link to Returns")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)\[`T`]>

the instance of the metadata property builder.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`typed`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#typed)

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `NodeAnnotationBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-18 "Direct link to Returns")

`NodeAnnotationBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#uncontrolledvalue)

***

### withDefaultEditor()[​](#withdefaulteditor "Direct link to withDefaultEditor()")

> **withDefaultEditor**(`defaultEditor`): `NodeAnnotationBuilder`<`T`>

Specifies the default editor for the property.

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### defaultEditor[​](#defaulteditor-1 "Direct link to defaultEditor")

[`NodeEditorType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType)

the default editor.

#### Returns[​](#returns-19 "Direct link to Returns")

`NodeAnnotationBuilder`<`T`>

the modified instance of the builder.

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-20 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`withEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#witheditorprops)

***

### withInsertRestriction()[​](#withinsertrestriction "Direct link to withInsertRestriction()")

> **withInsertRestriction**(`predicate?`): `NodeAnnotationBuilder`<`T`>

Specifies a function that checks whether a child component can be inserted into a parent component.

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### predicate?[​](#predicate "Direct link to predicate?")

(`self`, `child`) => `boolean`

the function that returns a boolean value.

#### Returns[​](#returns-21 "Direct link to Returns")

`NodeAnnotationBuilder`<`T`>

the modified instance of the builder.

***

### withSlotConditionBuilder()[​](#withslotconditionbuilder "Direct link to withSlotConditionBuilder()")

> **withSlotConditionBuilder**(`slotConditionBuilder`): `this`

Specifies a function that will create conditions that check if a child component can be bound to a parent slot.

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### slotConditionBuilder[​](#slotconditionbuilder "Direct link to slotConditionBuilder")

(`props`) => `string`

the function that returns a string containing the source code of the function to bind child components.

#### Returns[​](#returns-22 "Direct link to Returns")

`this`

the instance of the metadata property builder.

***

### create()[​](#create "Direct link to create()")

> `static` **create**<`T`>(`editor`): [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`T`>

Creates a component property metadata builder.

#### Type Parameters[​](#type-parameters-4 "Direct link to Type Parameters")

##### T[​](#t-2 "Direct link to T")

`T`

the property type.

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### editor[​](#editor-1 "Direct link to editor")

`string`

the property editor type.

#### Returns[​](#returns-23 "Direct link to Returns")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`T`>

the component property metadata builder.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder).[`create`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder#create)


---

# Class: NoopLocalizationEngine

A no-operation localization engine that provides empty implementations. Used when localization is not needed or as a fallback.

## Implements[​](#implements "Direct link to Implements")

* [`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new NoopLocalizationEngine**(`locale?`): `NoopLocalizationEngine`

#### Parameters[​](#parameters "Direct link to Parameters")

##### locale?[​](#locale "Direct link to locale?")

`` `${string}-${string}` ``

#### Returns[​](#returns "Direct link to Returns")

`NoopLocalizationEngine`

#### Inherit Doc[​](#inherit-doc "Direct link to Inherit Doc")

## Accessors[​](#accessors "Direct link to Accessors")

### language[​](#language "Direct link to language")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **language**(): `` `${string}-${string}` ``

The current language.

##### Returns[​](#returns-1 "Direct link to Returns")

`` `${string}-${string}` ``

#### Set Signature[​](#set-signature "Direct link to Set Signature")

> **set** **language**(`locale`): `void`

The current language.

##### Parameters[​](#parameters-1 "Direct link to Parameters")

###### locale[​](#locale-1 "Direct link to locale")

`` `${string}-${string}` ``

##### Returns[​](#returns-2 "Direct link to Returns")

`void`

The current language.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#language)

## Methods[​](#methods "Direct link to Methods")

### addMessages()[​](#addmessages "Direct link to addMessages()")

> **addMessages**(): `never`\[]

Adds messages to the localization engine.

#### Returns[​](#returns-3 "Direct link to Returns")

`never`\[]

the array of any localization errors that occurred.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`addMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#addmessages)

***

### getCompatibleId()[​](#getcompatibleid "Direct link to getCompatibleId()")

> **getCompatibleId**(`rawId`): `string`

Gets a compatible ID for localization engine.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### rawId[​](#rawid "Direct link to rawId")

`string`

the raw ID to make compatible.

#### Returns[​](#returns-4 "Direct link to Returns")

`string`

the compatible ID.

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`getCompatibleId`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#getcompatibleid)

***

### localizeErrorMessage()[​](#localizeerrormessage "Direct link to localizeErrorMessage()")

> **localizeErrorMessage**(): `undefined`

Localizes error messages for validation rules.

#### Returns[​](#returns-5 "Direct link to Returns")

`undefined`

the localized error message or undefined.

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`localizeErrorMessage`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#localizeerrormessage)

***

### localizeProperties()[​](#localizeproperties "Direct link to localizeProperties()")

> **localizeProperties**(): `object`

Localizes properties for a component.

#### Returns[​](#returns-6 "Direct link to Returns")

`object`

the object with localized property values.

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine).[`localizeProperties`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine#localizeproperties)


---

# Class: OneOfBuilder\<T>

The builder class to define the metadata property of the form builder component. Used for properties where the property value can be selected from one of the predefined values.

## Extends[​](#extends "Direct link to Extends")

* [`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)<`T`>

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new OneOfBuilder**<`T`>(): `OneOfBuilder`<`T`>

#### Returns[​](#returns "Direct link to Returns")

`OneOfBuilder`<`T`>

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#constructor)

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#annotation)

***

### labels?[​](#labels "Direct link to labels?")

> `optional` **labels**: `string`\[]

Labels for the possible values of the property.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`labels`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#labels)

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`options`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#options)

***

### values[​](#values "Direct link to values")

> **values**: (`string` | `number`)\[]

Possible values for the property.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`values`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#values)

## Accessors[​](#accessors "Direct link to Accessors")

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-1 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`dataBound`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#databound)

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-2 "Direct link to Returns")

`this`

the component property that can be localized.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`localize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#localize)

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the non-localizable component property.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`notLocalize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#notlocalize)

***

### required[​](#required "Direct link to required")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **required**(): [`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)<`NonNullable`<`T`>>

Marks the component property as required.

##### Returns[​](#returns-4 "Direct link to Returns")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)<`NonNullable`<`T`>>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#required)

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-5 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#valued)

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-6 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`build`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#build)

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `OneOfBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-7 "Direct link to Returns")

`OneOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#calculable)

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-8 "Direct link to Returns")

`this`

the cloned instance of the builder.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#clone)

***

### default()[​](#default "Direct link to default()")

> **default**(`value`): `this`

Sets the default value for the component property.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`T`

the default value.

#### Returns[​](#returns-9 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Overrides[​](#overrides "Direct link to Overrides")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#default)

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-10 "Direct link to Returns")

`string`

the annotation name.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`getName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#getname)

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-11 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`hideEditor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#hideeditor)

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `OneOfBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-12 "Direct link to Returns")

`OneOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`hinted`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#hinted)

***

### labeled()[​](#labeled "Direct link to labeled()")

> **labeled**(...`labels`): `OneOfBuilder`<`T`>

Sets the labels for predefined values.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### labels[​](#labels-1 "Direct link to labels")

...`string`\[]

the labels.

#### Returns[​](#returns-13 "Direct link to Returns")

`OneOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`labeled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#labeled)

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `OneOfBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-14 "Direct link to Returns")

`OneOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`named`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#named)

***

### radio()[​](#radio "Direct link to radio()")

> **radio**(): `OneOfBuilder`<`T`>

Sets the radio buttons as the component's property editor.

#### Returns[​](#returns-15 "Direct link to Returns")

`OneOfBuilder`<`T`>

the modified instance of the builder.

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-16 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`setup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#setup)

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `OneOfBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-17 "Direct link to Returns")

`OneOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#uncontrolledvalue)

***

### validated()[​](#validated "Direct link to validated()")

> **validated**(`validator`, `errorMap`): `this`

Modifies the component property metadata builder with validation properties.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### validator[​](#validator "Direct link to validator")

[`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)<`T`>

the validation function.

##### errorMap[​](#errormap "Direct link to errorMap")

[`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

the validation error settings.

#### Returns[​](#returns-18 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`validated`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#validated)

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-19 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`withEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#witheditorprops)


---

# Class: PropertyAnnotation

Metadata for the component property for the form builder.

## Extends[​](#extends "Direct link to Extends")

* [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new PropertyAnnotation**(`key`, `name`): `PropertyAnnotation`

Creates metadata for a React component property.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the property name.

##### name[​](#name "Direct link to name")

`string`

the human-readable property name.

#### Returns[​](#returns "Direct link to Returns")

`PropertyAnnotation`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#constructor)

## Properties[​](#properties "Direct link to Properties")

### bindingType?[​](#bindingtype "Direct link to bindingType?")

> `readonly` `optional` **bindingType**: [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)

The component property binding type.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`bindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#bindingtype)

***

### calculable[​](#calculable "Direct link to calculable")

> `readonly` **calculable**: `boolean` = `true`

True if the property value can be a calculated property, false otherwise.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#calculable)

***

### controlsRequiredProp[​](#controlsrequiredprop "Direct link to controlsRequiredProp")

> `readonly` **controlsRequiredProp**: `boolean` = `false`

True if the property value controls a required flag, false otherwise.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`controlsRequiredProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#controlsrequiredprop)

***

### data[​](#data "Direct link to data")

> **data**: [`LabeledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue)\[]

Possible values for the property.

***

### dataBindingType[​](#databindingtype "Direct link to dataBindingType")

> `readonly` **dataBindingType**: [`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

The type of component data binding.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`dataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#databindingtype)

***

### default?[​](#default "Direct link to default?")

> `readonly` `optional` **default**: `any`

The default property value.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#default)

***

### disabled[​](#disabled "Direct link to disabled")

> `readonly` **disabled**: `boolean` = `false`

True if the property value controls a disabled flag, false otherwise.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`disabled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#disabled)

***

### editor[​](#editor "Direct link to editor")

> `readonly` **editor**: `string`

The name of the component's property editor.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editor)

***

### editorProps?[​](#editorprops "Direct link to editorProps?")

> `readonly` `optional` **editorProps**: `any`

Additional properties for the component property editor.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editorprops)

***

### errorMap?[​](#errormap "Direct link to errorMap?")

> `readonly` `optional` **errorMap**: [`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

Message and/or error code for the validation function.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`errorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#errormap)

***

### hint?[​](#hint "Direct link to hint?")

> `readonly` `optional` **hint**: `ReactNode`

The hint for the component property.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`hint`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#hint)

***

### key[​](#key-1 "Direct link to key")

> `readonly` **key**: `string`

The component property key.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`key`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#key)

***

### localizable[​](#localizable "Direct link to localizable")

> `readonly` **localizable**: `boolean` = `false`

True if the property value can be localized, false otherwise.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`localizable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#localizable)

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

The component property name.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`name`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#name)

***

### readOnly[​](#readonly "Direct link to readOnly")

> `readonly` **readOnly**: `boolean` = `false`

True if the property value controls a read-only flag, false otherwise.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`readOnly`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#readonly)

***

### required[​](#required "Direct link to required")

> `readonly` **required**: `boolean` = `false`

True if the component property is required, false otherwise.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#required)

***

### slotConditionBuilder()?[​](#slotconditionbuilder "Direct link to slotConditionBuilder()?")

> `readonly` `optional` **slotConditionBuilder**: (`props`) => `string`

A function that returns a string containing the source code of the function to bind child components.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the properties of the component, which are available only inside Form Builder Designer.

#### Returns[​](#returns-1 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`slotConditionBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#slotconditionbuilder)

***

### type?[​](#type "Direct link to type?")

> `readonly` `optional` **type**: keyof SchemaTypeMap

The data type for the value of the property.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`type`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#type)

***

### uncontrolledValue?[​](#uncontrolledvalue "Direct link to uncontrolledValue?")

> `readonly` `optional` **uncontrolledValue**: `unknown`

The property value for the uncontrolled state.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#uncontrolledvalue)

***

### validator?[​](#validator "Direct link to validator?")

> `readonly` `optional` **validator**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The function for validating the property value.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`validator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#validator)

***

### valued[​](#valued "Direct link to valued")

> `readonly` **valued**: `boolean` = `false`

True if the property value is bound to form data, false otherwise.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#valued)

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `any`

#### Returns[​](#returns-2 "Direct link to Returns")

`any`

the metadata clone.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#clone)


---

# Class: `abstract` QuantifierBuilder\<T>

The abstract builder class to define the metadata property of the form builder component. Used for properties where the property value can be selected from predefined values.

## Extends[​](#extends "Direct link to Extends")

* [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`T`>

## Extended by[​](#extended-by "Direct link to Extended by")

* [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)
* [`SomeOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new QuantifierBuilder**<`T`>(): `QuantifierBuilder`<`T`>

#### Returns[​](#returns "Direct link to Returns")

`QuantifierBuilder`<`T`>

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#constructor)

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#annotation)

***

### labels?[​](#labels "Direct link to labels?")

> `optional` **labels**: `string`\[]

Labels for the possible values of the property.

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`options`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#options)

***

### values[​](#values "Direct link to values")

> **values**: (`string` | `number`)\[]

Possible values for the property.

## Accessors[​](#accessors "Direct link to Accessors")

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-1 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`dataBound`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#databound)

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-2 "Direct link to Returns")

`this`

the component property that can be localized.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`localize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#localize)

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the non-localizable component property.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`notLocalize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#notlocalize)

***

### required[​](#required "Direct link to required")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **required**(): `QuantifierBuilder`<`NonNullable`<`T`>>

Marks the component property as required.

##### Returns[​](#returns-4 "Direct link to Returns")

`QuantifierBuilder`<`NonNullable`<`T`>>

the modified instance of the builder.

#### Overrides[​](#overrides "Direct link to Overrides")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#required)

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-5 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#valued)

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-6 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`build`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#build)

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `QuantifierBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-7 "Direct link to Returns")

`QuantifierBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#calculable)

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-8 "Direct link to Returns")

`this`

the cloned instance of the builder.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#clone)

***

### default()[​](#default "Direct link to default()")

> **default**(`value`): `this`

Sets the default value for the component property.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

the default value, can be an array of values.

`T` | `T`\[]

#### Returns[​](#returns-9 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Overrides[​](#overrides-2 "Direct link to Overrides")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#default)

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-10 "Direct link to Returns")

`string`

the annotation name.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`getName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#getname)

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-11 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`hideEditor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#hideeditor)

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `QuantifierBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-12 "Direct link to Returns")

`QuantifierBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`hinted`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#hinted)

***

### labeled()[​](#labeled "Direct link to labeled()")

> **labeled**(...`labels`): `QuantifierBuilder`<`T`>

Sets the labels for predefined values.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### labels[​](#labels-1 "Direct link to labels")

...`string`\[]

the labels.

#### Returns[​](#returns-13 "Direct link to Returns")

`QuantifierBuilder`<`T`>

the modified instance of the builder.

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `QuantifierBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-14 "Direct link to Returns")

`QuantifierBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`named`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#named)

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-15 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`setup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#setup)

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `QuantifierBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-16 "Direct link to Returns")

`QuantifierBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#uncontrolledvalue)

***

### validated()[​](#validated "Direct link to validated()")

> **validated**(`validator`, `errorMap`): `this`

Modifies the component property metadata builder with validation properties.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### validator[​](#validator "Direct link to validator")

[`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)<`T`>

the validation function.

##### errorMap[​](#errormap "Direct link to errorMap")

[`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

the validation error settings.

#### Returns[​](#returns-17 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`validated`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#validated)

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-18 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder).[`withEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder#witheditorprops)


---

# Class: SomeOfBuilder\<T>

The builder class to define the metadata property of the form builder component. Used for properties where the property value can be a set of predefined values.

## Extends[​](#extends "Direct link to Extends")

* [`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)<`T`>

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new SomeOfBuilder**<`T`>(): `SomeOfBuilder`<`T`>

#### Returns[​](#returns "Direct link to Returns")

`SomeOfBuilder`<`T`>

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#constructor)

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#annotation)

***

### labels?[​](#labels "Direct link to labels?")

> `optional` **labels**: `string`\[]

Labels for the possible values of the property.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`labels`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#labels)

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`options`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#options)

***

### values[​](#values "Direct link to values")

> **values**: (`string` | `number`)\[]

Possible values for the property.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`values`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#values)

## Accessors[​](#accessors "Direct link to Accessors")

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-1 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`dataBound`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#databound)

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-2 "Direct link to Returns")

`this`

the component property that can be localized.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`localize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#localize)

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the non-localizable component property.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`notLocalize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#notlocalize)

***

### required[​](#required "Direct link to required")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **required**(): [`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)<`NonNullable`<`T`>>

Marks the component property as required.

##### Returns[​](#returns-4 "Direct link to Returns")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)<`NonNullable`<`T`>>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#required)

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-5 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#valued)

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-6 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`build`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#build)

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `SomeOfBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-7 "Direct link to Returns")

`SomeOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#calculable)

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-8 "Direct link to Returns")

`this`

the cloned instance of the builder.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#clone)

***

### default()[​](#default "Direct link to default()")

> **default**(`value`): `this`

Sets the default value for the component property.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`T`\[]

the default value.

#### Returns[​](#returns-9 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Overrides[​](#overrides "Direct link to Overrides")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#default)

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-10 "Direct link to Returns")

`string`

the annotation name.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`getName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#getname)

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-11 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`hideEditor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#hideeditor)

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `SomeOfBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-12 "Direct link to Returns")

`SomeOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`hinted`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#hinted)

***

### labeled()[​](#labeled "Direct link to labeled()")

> **labeled**(...`labels`): `SomeOfBuilder`<`T`>

Sets the labels for predefined values.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### labels[​](#labels-1 "Direct link to labels")

...`string`\[]

the labels.

#### Returns[​](#returns-13 "Direct link to Returns")

`SomeOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`labeled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#labeled)

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `SomeOfBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-14 "Direct link to Returns")

`SomeOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`named`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#named)

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-15 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`setup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#setup)

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `SomeOfBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-16 "Direct link to Returns")

`SomeOfBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#uncontrolledvalue)

***

### validated()[​](#validated "Direct link to validated()")

> **validated**(`validator`, `errorMap`): `this`

Modifies the component property metadata builder with validation properties.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### validator[​](#validator "Direct link to validator")

[`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)<`T`>

the validation function.

##### errorMap[​](#errormap "Direct link to errorMap")

[`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

the validation error settings.

#### Returns[​](#returns-17 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`validated`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#validated)

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-18 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

[`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder).[`withEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder#witheditorprops)


---

# Class: Store

The form viewer settings. **Internal use only.**

## Implements[​](#implements "Direct link to Implements")

* [`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)
* [`IFormViewer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer)
* [`IComponentDataFactory`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentDataFactory)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new Store**(`formViewerPropsStore`, `componentStateFactory`, `parentStore?`, `getInitialData?`, `setInitialData?`): `Store`

Creates form viewer settings.

#### Parameters[​](#parameters "Direct link to Parameters")

##### formViewerPropsStore[​](#formviewerpropsstore "Direct link to formViewerPropsStore")

[`FormViewerPropsStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/FormViewerPropsStore)

the form viewer store settings.

##### componentStateFactory[​](#componentstatefactory "Direct link to componentStateFactory")

[`ComponentStateFactory`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStateFactory)

the factory for creating component states.

##### parentStore?[​](#parentstore "Direct link to parentStore?")

`Store`

the form viewer settings, used in templates.

##### getInitialData?[​](#getinitialdata "Direct link to getInitialData?")

[`GetInitialDataFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/GetInitialDataFn)

the function to get initial data for the Store.

##### setInitialData?[​](#setinitialdata "Direct link to setInitialData?")

[`SetInitialDataFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SetInitialDataFn)

the function for updating initial data.

#### Returns[​](#returns "Direct link to Returns")

`Store`

## Properties[​](#properties "Direct link to Properties")

### componentStateFactory[​](#componentstatefactory-1 "Direct link to componentStateFactory")

> `readonly` **componentStateFactory**: [`ComponentStateFactory`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStateFactory)

the factory for creating component states.

***

### form[​](#form "Direct link to form")

> **form**: [`Form`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Form)

The form.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore).[`form`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore#form)

***

### formLoadError?[​](#formloaderror "Direct link to formLoadError?")

> `optional` **formLoadError**: `string`

The loading form error.

***

### formViewerPropsStore[​](#formviewerpropsstore-1 "Direct link to formViewerPropsStore")

> **formViewerPropsStore**: [`FormViewerPropsStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/FormViewerPropsStore)

the form viewer store settings.

***

### getInitialData?[​](#getinitialdata-1 "Direct link to getInitialData?")

> `readonly` `optional` **getInitialData**: [`GetInitialDataFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/GetInitialDataFn)

the function to get initial data for the Store.

***

### parentStore?[​](#parentstore-1 "Direct link to parentStore?")

> `readonly` `optional` **parentStore**: `Store`

the form viewer settings, used in templates.

***

### selectedLanguage?[​](#selectedlanguage "Direct link to selectedLanguage?")

> `optional` **selectedLanguage**: [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

The currently selected language.

***

### setInitialData?[​](#setinitialdata-1 "Direct link to setInitialData?")

> `readonly` `optional` **setInitialData**: [`SetInitialDataFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SetInitialDataFn)

the function for updating initial data.

***

### viewMode[​](#viewmode "Direct link to viewMode")

> **viewMode**: [`ViewMode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ViewMode) = `'desktop'`

Current display resolution type.

## Accessors[​](#accessors "Direct link to Accessors")

### commonActions[​](#commonactions "Direct link to commonActions")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **commonActions**(): [`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

##### Returns[​](#returns-1 "Direct link to Returns")

[`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

the Record with the common actions.

***

### displayedLanguage[​](#displayedlanguage "Direct link to displayedLanguage")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **displayedLanguage**(): [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

##### Returns[​](#returns-2 "Direct link to Returns")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the current display language.

***

### formData[​](#formdata "Direct link to formData")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **formData**(): [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

##### Returns[​](#returns-3 "Direct link to Returns")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the [IFormData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData) with all the form data.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IFormViewer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer).[`formData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer#formdata)

***

### initialDataSlice[​](#initialdataslice "Direct link to initialDataSlice")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **initialDataSlice**(): `unknown`

##### Returns[​](#returns-4 "Direct link to Returns")

`unknown`

the slice of the initial data in accordance with the Store hierarchy. **Internal use only.**

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore).[`initialDataSlice`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore#initialdataslice)

***

### showAllValidationErrors[​](#showallvalidationerrors "Direct link to showAllValidationErrors")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **showAllValidationErrors**(): `undefined` | `boolean`

##### Returns[​](#returns-5 "Direct link to Returns")

`undefined` | `boolean`

true if all validation errors are to be displayed, false otherwise.

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore).[`showAllValidationErrors`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore#showallvalidationerrors)

## Methods[​](#methods "Direct link to Methods")

### applyPersistedForm()[​](#applypersistedform "Direct link to applyPersistedForm()")

> **applyPersistedForm**(`persistedForm`): `void`

Populates the value of this store with the values of the saved form.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### persistedForm[​](#persistedform "Direct link to persistedForm")

[`PersistedForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/PersistedForm)

saved form value.

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

***

### applyStringForm()[​](#applystringform "Direct link to applyStringForm()")

> **applyStringForm**(`text`): `void`

Populates the value of this store with the values of the saved form.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### text[​](#text "Direct link to text")

`string`

saved form value.

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

***

### clear()[​](#clear "Direct link to clear()")

> **clear**(): `void`

Clears the form in Form Viewer.

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

***

### createComponentData()[​](#createcomponentdata "Direct link to createComponentData()")

> **createComponentData**(`componentStore`, `deferFieldCalculation`): [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

Creates the element for the component tree. **Internal use only.**

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

##### deferFieldCalculation[​](#deferfieldcalculation "Direct link to deferFieldCalculation")

`boolean` = `false`

if true, then the calculated field must be explicitly initialized.

#### Returns[​](#returns-9 "Direct link to Returns")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the element for the component tree.

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IComponentDataFactory`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentDataFactory).[`createComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentDataFactory#createcomponentdata)

***

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**(): `void`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore).[`dispose`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore#dispose)

***

### findAction()[​](#findaction "Direct link to findAction()")

> **findAction**(`actionData`): [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)

Searches for an action, returns definition for the found action.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### actionData[​](#actiondata "Direct link to actionData")

[`ActionData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData)

the action's data.

#### Returns[​](#returns-11 "Direct link to Returns")

[`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)

the action definition.

#### Throws[​](#throws "Direct link to Throws")

If the action was not found.

***

### getAction()[​](#getaction "Direct link to getAction()")

> **getAction**(`name`, `type`): [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)

Returns an action by the specified action name and action type.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the action name.

##### type[​](#type "Direct link to type")

[`ActionType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionType)

the action type.

#### Returns[​](#returns-12 "Direct link to Returns")

[`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)

the action.

***

### getFirstComponentTypeWithRole()[​](#getfirstcomponenttypewithrole "Direct link to getFirstComponentTypeWithRole()")

> **getFirstComponentTypeWithRole**(`componentRole`): `undefined` | `string`

Returns the first type of component with the specified role.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### componentRole[​](#componentrole "Direct link to componentRole")

`string`

the component role.

#### Returns[​](#returns-13 "Direct link to Returns")

`undefined` | `string`

the first type of component with the specified role.

***

### getModel()[​](#getmodel "Direct link to getModel()")

> **getModel**(`type`): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`> | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`InternalErrorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/InternalErrorProps)> | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`TemplateProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/TemplateProps)>

Returns model for the specified type.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### type[​](#type-1 "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-14 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`> | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`InternalErrorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/InternalErrorProps)> | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`TemplateProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/TemplateProps)>

the model for the specified type.

***

### getValidationRules()[​](#getvalidationrules "Direct link to getValidationRules()")

> **getValidationRules**(`type`): [`FormViewerValidationRules`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerValidationRules)

Returns the object with validators for the specified value type.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### type[​](#type-2 "Direct link to type")

keyof [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)

the value type.

#### Returns[​](#returns-15 "Direct link to Returns")

[`FormViewerValidationRules`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerValidationRules)

the object with validators for the specified value type.

***

### localizeComponent()[​](#localizecomponent "Direct link to localizeComponent()")

> **localizeComponent**(`type`, `formData`, `componentStore`): `Record`<`string`, `any`>

Localizes a component store based on the given localization type. If a custom localizer is available, it will be used.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### type[​](#type-3 "Direct link to type")

`string`

the type of localization.

##### formData[​](#formdata-1 "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data.

##### componentStore[​](#componentstore-1 "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

#### Returns[​](#returns-16 "Direct link to Returns")

`Record`<`string`, `any`>

the Record with the localized properties.

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore).[`localizeComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore#localizecomponent)

***

### localizeErrorMessages()[​](#localizeerrormessages "Direct link to localizeErrorMessages()")

> **localizeErrorMessages**(`formData`, `componentStore`, `validationResults?`): `undefined` | `string`\[]

The function to localize the validation error message.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### formData[​](#formdata-2 "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data.

##### componentStore[​](#componentstore-2 "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

##### validationResults?[​](#validationresults "Direct link to validationResults?")

[`ValidationResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult)\[]

the results of the validation.

#### Returns[​](#returns-17 "Direct link to Returns")

`undefined` | `string`\[]

the result of localization or undefined.

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore).[`localizeErrorMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore#localizeerrormessages)

***

### reduceScreen()[​](#reducescreen "Direct link to reduceScreen()")

> **reduceScreen**<`T`>(`callback`, `initialValue`): `T`

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

##### T[​](#t "Direct link to T")

`T`

the return value type.

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### callback[​](#callback "Direct link to callback")

(`accumulator`, `current`) => `T`

the function that calculates the value for the accumulator.

##### initialValue[​](#initialvalue "Direct link to initialValue")

`T`

the initial value for the accumulator.

#### Returns[​](#returns-18 "Direct link to Returns")

`T`

the accumulated value.

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore).[`reduceScreen`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore#reducescreen)


---

# Class: StyleAnnotation

Metadata for the component style property for the form builder.

## Extends[​](#extends "Direct link to Extends")

* [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new StyleAnnotation**(`key`, `name`): `StyleAnnotation`

Creates metadata for a React component property.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the property name.

##### name[​](#name "Direct link to name")

`string`

the human-readable property name.

#### Returns[​](#returns "Direct link to Returns")

`StyleAnnotation`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#constructor)

## Properties[​](#properties "Direct link to Properties")

### bindingType?[​](#bindingtype "Direct link to bindingType?")

> `readonly` `optional` **bindingType**: [`ComponentPropertyBindType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType)

The component property binding type.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`bindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#bindingtype)

***

### calculable[​](#calculable "Direct link to calculable")

> `readonly` **calculable**: `boolean` = `true`

True if the property value can be a calculated property, false otherwise.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#calculable)

***

### controlsRequiredProp[​](#controlsrequiredprop "Direct link to controlsRequiredProp")

> `readonly` **controlsRequiredProp**: `boolean` = `false`

True if the property value controls a required flag, false otherwise.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`controlsRequiredProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#controlsrequiredprop)

***

### dataBindingType[​](#databindingtype "Direct link to dataBindingType")

> `readonly` **dataBindingType**: [`DataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType) = `'none'`

The type of component data binding.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`dataBindingType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#databindingtype)

***

### default?[​](#default "Direct link to default?")

> `readonly` `optional` **default**: `any`

The default property value.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`default`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#default)

***

### disabled[​](#disabled "Direct link to disabled")

> `readonly` **disabled**: `boolean` = `false`

True if the property value controls a disabled flag, false otherwise.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`disabled`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#disabled)

***

### editor[​](#editor "Direct link to editor")

> `readonly` **editor**: `string`

The name of the component's property editor.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editor)

***

### editorProps?[​](#editorprops "Direct link to editorProps?")

> `readonly` `optional` **editorProps**: `any`

Additional properties for the component property editor.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`editorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#editorprops)

***

### errorMap?[​](#errormap "Direct link to errorMap?")

> `readonly` `optional` **errorMap**: [`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

Message and/or error code for the validation function.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`errorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#errormap)

***

### hint?[​](#hint "Direct link to hint?")

> `readonly` `optional` **hint**: `ReactNode`

The hint for the component property.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`hint`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#hint)

***

### key[​](#key-1 "Direct link to key")

> `readonly` **key**: `string`

The component property key.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`key`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#key)

***

### localizable[​](#localizable "Direct link to localizable")

> `readonly` **localizable**: `boolean` = `false`

True if the property value can be localized, false otherwise.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`localizable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#localizable)

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

The component property name.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`name`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#name)

***

### readOnly[​](#readonly "Direct link to readOnly")

> `readonly` **readOnly**: `boolean` = `false`

True if the property value controls a read-only flag, false otherwise.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`readOnly`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#readonly)

***

### required[​](#required "Direct link to required")

> `readonly` **required**: `boolean` = `false`

True if the component property is required, false otherwise.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`required`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#required)

***

### slotConditionBuilder()?[​](#slotconditionbuilder "Direct link to slotConditionBuilder()?")

> `readonly` `optional` **slotConditionBuilder**: (`props`) => `string`

A function that returns a string containing the source code of the function to bind child components.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the properties of the component, which are available only inside Form Builder Designer.

#### Returns[​](#returns-1 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`slotConditionBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#slotconditionbuilder)

***

### type?[​](#type "Direct link to type?")

> `readonly` `optional` **type**: keyof SchemaTypeMap

The data type for the value of the property.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`type`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#type)

***

### uncontrolledValue?[​](#uncontrolledvalue "Direct link to uncontrolledValue?")

> `readonly` `optional` **uncontrolledValue**: `unknown`

The property value for the uncontrolled state.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#uncontrolledvalue)

***

### validator?[​](#validator "Direct link to validator?")

> `readonly` `optional` **validator**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The function for validating the property value.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`validator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#validator)

***

### valued[​](#valued "Direct link to valued")

> `readonly` **valued**: `boolean` = `false`

True if the property value is bound to form data, false otherwise.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#valued)

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `any`

#### Returns[​](#returns-2 "Direct link to Returns")

`any`

the metadata clone.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation#clone)


---

# Class: SyncEvent\<TSender, TEventArgs>

Represents a synchronous event that can be subscribed to and invoked. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### TSender[​](#tsender "Direct link to TSender")

`TSender`

the type of the object that raises the event.

### TEventArgs[​](#teventargs "Direct link to TEventArgs")

`TEventArgs`

the type of the event arguments.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new SyncEvent**<`TSender`, `TEventArgs`>(): `SyncEvent`<`TSender`, `TEventArgs`>

#### Returns[​](#returns "Direct link to Returns")

`SyncEvent`<`TSender`, `TEventArgs`>

## Accessors[​](#accessors "Direct link to Accessors")

### isSubscribed[​](#issubscribed "Direct link to isSubscribed")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **isSubscribed**(): `boolean`

Returns true if the object has subscribers, false otherwise.

##### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

true if the object has handlers registered for events, otherwise returns false.

## Methods[​](#methods "Direct link to Methods")

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**(): `void`

Dispose method to release all handlers.

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

***

### invoke()[​](#invoke "Direct link to invoke()")

> **invoke**(`sender`, `eventArgs`): `void`

Invokes the event by calling all registered event handlers.

#### Parameters[​](#parameters "Direct link to Parameters")

##### sender[​](#sender "Direct link to sender")

`TSender`

the sender of the event.

##### eventArgs[​](#eventargs "Direct link to eventArgs")

`TEventArgs`

the event arguments.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### subscribe()[​](#subscribe "Direct link to subscribe()")

> **subscribe**(`handler`): `void`

Adds a handler to the list of subscribers.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### handler[​](#handler "Direct link to handler")

[`SyncEventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SyncEventHandler)<`TSender`, `TEventArgs`>

the handler function to be added.

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

***

### unsubscribe()[​](#unsubscribe "Direct link to unsubscribe()")

> **unsubscribe**(`handler`): `void`

Removes the specified event handler from the list of handlers.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### handler[​](#handler-1 "Direct link to handler")

[`SyncEventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SyncEventHandler)<`TSender`, `TEventArgs`>

the event handler to remove.

#### Returns[​](#returns-5 "Direct link to Returns")

`void`


---

# Class: TemplateField

The field with the form data, contains the value of the nested form. **Internal use only.**

## Implements[​](#implements "Direct link to Implements")

* [`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new TemplateField**(`componentStore`, `viewerStore`): `TemplateField`

Creates the nested form field with form data for the component.

#### Parameters[​](#parameters "Direct link to Parameters")

##### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

##### viewerStore[​](#viewerstore "Direct link to viewerStore")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)

the form viewer settings.

#### Returns[​](#returns "Direct link to Returns")

`TemplateField`

## Properties[​](#properties "Direct link to Properties")

### componentStore[​](#componentstore-1 "Direct link to componentStore")

> `readonly` **componentStore**: [`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

***

### touched[​](#touched "Direct link to touched")

> **touched**: `boolean` = `false`

Flag, true, if the field is marked as touched.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`touched`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#touched)

***

### valued[​](#valued "Direct link to valued")

> **valued**: `string` = `''`

The name of the component property that contains the field value.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#valued)

***

### viewerStore[​](#viewerstore-1 "Direct link to viewerStore")

> `readonly` **viewerStore**: [`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)

the form viewer settings.

## Accessors[​](#accessors "Direct link to Accessors")

### errors[​](#errors "Direct link to errors")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **errors**(): `Record`<`string`, `unknown`>

Contains a field validation errors if the field provides multiple errors (i.e. field is template). Contains an array of field validation errors if the field contains an array of components.

##### Returns[​](#returns-1 "Direct link to Returns")

`Record`<`string`, `unknown`>

Contains a field validation errors if the field provides multiple errors (i.e. field is template). Contains an array of field validation errors if the field contains an array of components.

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`errors`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#errors)

***

### fieldType[​](#fieldtype "Direct link to fieldType")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **fieldType**(): [`FieldType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FieldType)

The field type.

##### Returns[​](#returns-2 "Direct link to Returns")

[`FieldType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FieldType)

The field type.

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`fieldType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#fieldtype)

***

### form[​](#form "Direct link to form")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **form**(): [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

##### Returns[​](#returns-3 "Direct link to Returns")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the form for the field.

***

### storeDataInParentForm[​](#storedatainparentform "Direct link to storeDataInParentForm")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **storeDataInParentForm**(): `any`

Flag, false if nested form data show as nested object, true otherwise.

##### Returns[​](#returns-4 "Direct link to Returns")

`any`

Flag, false if nested form data show as nested object, true otherwise.

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`storeDataInParentForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#storedatainparentform)

***

### value[​](#value "Direct link to value")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **value**(): `unknown`

Value of the field.

##### Returns[​](#returns-5 "Direct link to Returns")

`unknown`

Value of the field.

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`value`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#value)

## Methods[​](#methods "Direct link to Methods")

### clear()[​](#clear "Direct link to clear()")

> **clear**(): `void`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`clear`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#clear)

***

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**(): `void`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-1 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`dispose`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#dispose)

***

### getValidationResult()[​](#getvalidationresult "Direct link to getValidationResult()")

> **getValidationResult**(): `Promise`<`undefined`>

#### Returns[​](#returns-8 "Direct link to Returns")

`Promise`<`undefined`>

the [ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) validation results.

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`getValidationResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#getvalidationresult)

***

### init()[​](#init "Direct link to init()")

> **init**(): `void`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-2 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-9 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`init`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#init)

***

### reset()[​](#reset "Direct link to reset()")

> **reset**(): `void`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-3 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-10 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`reset`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#reset)

***

### setError()[​](#seterror "Direct link to setError()")

> **setError**(`error`): `void`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### error[​](#error "Direct link to error")

`unknown`

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-4 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-11 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`setError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#seterror)

***

### setTouched()[​](#settouched "Direct link to setTouched()")

> **setTouched**(): `void`

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-5 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-12 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`setTouched`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#settouched)

***

### setValue()[​](#setvalue "Direct link to setValue()")

> **setValue**(`value`): `void`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`unknown`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc-6 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-13 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`setValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#setvalue)

***

### validate()[​](#validate "Direct link to validate()")

> **validate**(): `Promise`<`void`>

#### Returns[​](#returns-14 "Direct link to Returns")

`Promise`<`void`>

#### Inherit Doc[​](#inherit-doc-7 "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-14 "Direct link to Implementation of")

[`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field).[`validate`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field#validate)


---

# Class: TypedBuilder\<T>

The builder class to define the metadata property of the form builder component. Used for properties where the property value can be validated.

## Extends[​](#extends "Direct link to Extends")

* [`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder)<`T`>

## Extended by[​](#extended-by "Direct link to Extended by")

* [`ArrayBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder)
* [`QuantifierBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder)

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new TypedBuilder**<`T`>(): `TypedBuilder`<`T`>

#### Returns[​](#returns "Direct link to Returns")

`TypedBuilder`<`T`>

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`constructor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#constructor)

## Properties[​](#properties "Direct link to Properties")

### annotation[​](#annotation "Direct link to annotation")

> **annotation**: [`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation)

Partial metadata for a component property.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#annotation)

***

### options[​](#options "Direct link to options")

> **options**: [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)

Options for building an annotation.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`options`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#options)

## Accessors[​](#accessors "Direct link to Accessors")

### dataBound[​](#databound "Direct link to dataBound")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **dataBound**(): `this`

##### Returns[​](#returns-1 "Direct link to Returns")

`this`

the main property of the component that uses the form data as data (one-way data binding).

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`dataBound`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#databound)

***

### localize[​](#localize "Direct link to localize")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **localize**(): `this`

##### Returns[​](#returns-2 "Direct link to Returns")

`this`

the component property that can be localized.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`localize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#localize)

***

### notLocalize[​](#notlocalize "Direct link to notLocalize")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **notLocalize**(): `this`

##### Returns[​](#returns-3 "Direct link to Returns")

`this`

the non-localizable component property.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`notLocalize`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#notlocalize)

***

### required[​](#required "Direct link to required")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **required**(): `TypedBuilder`<`NonNullable`<`T`>>

Marks the component property as required.

##### Returns[​](#returns-4 "Direct link to Returns")

`TypedBuilder`<`NonNullable`<`T`>>

the modified instance of the builder.

***

### valued[​](#valued "Direct link to valued")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **valued**(): `this`

##### Returns[​](#returns-5 "Direct link to Returns")

`this`

the main component property that is used as form data and for validation rules.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`valued`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#valued)

## Methods[​](#methods "Direct link to Methods")

### build()[​](#build "Direct link to build()")

> **build**(`key`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

Creates component property metadata for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique key of the component property.

#### Returns[​](#returns-6 "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the instance of the component property metadata for the form builder.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`build`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#build)

***

### calculable()[​](#calculable "Direct link to calculable()")

> **calculable**(`calculable`): `TypedBuilder`<`T`>

Marks the component property as calculable.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### calculable[​](#calculable-1 "Direct link to calculable")

`boolean`

true if the property is calculable.

#### Returns[​](#returns-7 "Direct link to Returns")

`TypedBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`calculable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#calculable)

***

### clone()[​](#clone "Direct link to clone()")

> **clone**(): `this`

Clones the instance of the builder.

#### Returns[​](#returns-8 "Direct link to Returns")

`this`

the cloned instance of the builder.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`clone`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#clone)

***

### default()[​](#default "Direct link to default()")

> **default**(`value`): `this`

Sets the default value for the component property.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`T`

the default value.

#### Returns[​](#returns-9 "Direct link to Returns")

`this`

the modified instance of the builder.

***

### getName()[​](#getname "Direct link to getName()")

> `protected` **getName**(`key`): `string`

Returns the annotation name.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the property name

#### Returns[​](#returns-10 "Direct link to Returns")

`string`

the annotation name.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`getName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#getname)

***

### hideEditor()[​](#hideeditor "Direct link to hideEditor()")

> **hideEditor**(): `this`

Hides the component property editor.

#### Returns[​](#returns-11 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`hideEditor`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#hideeditor)

***

### hinted()[​](#hinted "Direct link to hinted()")

> **hinted**(`hint`): `TypedBuilder`<`T`>

Adds the hint to the property name of the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hint[​](#hint "Direct link to hint")

`ReactNode`

the hint.

#### Returns[​](#returns-12 "Direct link to Returns")

`TypedBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`hinted`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#hinted)

***

### named()[​](#named "Direct link to named()")

> **named**(`name`): `TypedBuilder`<`T`>

Specifies the name of the component property.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the property name.

#### Returns[​](#returns-13 "Direct link to Returns")

`TypedBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`named`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#named)

***

### setup()[​](#setup "Direct link to setup()")

> **setup**(`options`): `this`

Modifies the component property metadata builder with custom options.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### options[​](#options-1 "Direct link to options")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup)

the custom options.

#### Returns[​](#returns-14 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`setup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#setup)

***

### uncontrolledValue()[​](#uncontrolledvalue "Direct link to uncontrolledValue()")

> **uncontrolledValue**(`uncontrolledValue`): `TypedBuilder`<`T`>

Sets the value for the property that prevents uncontrolled state.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### uncontrolledValue[​](#uncontrolledvalue-1 "Direct link to uncontrolledValue")

`unknown`

the value for the uncontrolled state.

#### Returns[​](#returns-15 "Direct link to Returns")

`TypedBuilder`<`T`>

the modified instance of the builder.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`uncontrolledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#uncontrolledvalue)

***

### validated()[​](#validated "Direct link to validated()")

> **validated**(`validator`, `errorMap`): `this`

Modifies the component property metadata builder with validation properties.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### validator[​](#validator "Direct link to validator")

[`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)<`T`>

the validation function.

##### errorMap[​](#errormap "Direct link to errorMap")

[`ErrorMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap)

the validation error settings.

#### Returns[​](#returns-16 "Direct link to Returns")

`this`

the modified instance of the builder.

***

### withEditorProps()[​](#witheditorprops "Direct link to withEditorProps()")

> **withEditorProps**(`props`): `this`

Sets custom properties for the component's property editor.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### props[​](#props "Direct link to props")

`any`

the custom properties

#### Returns[​](#returns-17 "Direct link to Returns")

`this`

the modified instance of the builder.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

[`BaseBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder).[`withEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder#witheditorprops)


---

# Class: View

Represents all the metadata of the form viewer components.

## Extended by[​](#extended-by "Direct link to Extended by")

* [`BuilderView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView)
* [`BuilderView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/classes/BuilderView)

## Implements[​](#implements "Direct link to Implements")

* [`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView)

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new View**(`models`): `View`

Creates an instance of the View.

#### Parameters[​](#parameters "Direct link to Parameters")

##### models[​](#models "Direct link to models")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[] = `[]`

the components metadata.

#### Returns[​](#returns "Direct link to Returns")

`View`

## Accessors[​](#accessors "Direct link to Accessors")

### viewerWrappers[​](#viewerwrappers "Direct link to viewerWrappers")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **viewerWrappers**(): [`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)\[]

Retrieves the viewer wrappers array.

##### Returns[​](#returns-1 "Direct link to Returns")

[`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)\[]

the viewer wrappers array.

Retrieves the viewer wrappers array.

#### Implementation of[​](#implementation-of "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`viewerWrappers`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#viewerwrappers)

## Methods[​](#methods "Direct link to Methods")

### all()[​](#all "Direct link to all()")

> **all**(): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

#### Returns[​](#returns-2 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

all component metadata for the form viewer.

#### Implementation of[​](#implementation-of-1 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`all`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#all)

***

### define()[​](#define "Direct link to define()")

> **define**(`model`): `void`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### model[​](#model "Direct link to model")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherit Doc[​](#inherit-doc "Direct link to Inherit Doc")

#### Implementation of[​](#implementation-of-2 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`define`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#define)

***

### filterModels()[​](#filtermodels "Direct link to filterModels()")

> **filterModels**(`predicate`): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### predicate[​](#predicate "Direct link to predicate")

(`model`) => `boolean`

the filter function.

#### Returns[​](#returns-4 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

the array of component metadata filtered using the predicate function.

#### Implementation of[​](#implementation-of-3 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`filterModels`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#filtermodels)

***

### find()[​](#find "Direct link to find()")

> **find**(`type`): `undefined` | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-5 "Direct link to Returns")

`undefined` | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

the component metadata for the form viewer for the specified type or undefined.

#### Implementation of[​](#implementation-of-4 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`find`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#find)

***

### get()[​](#get "Direct link to get()")

> **get**(`type`): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### type[​](#type-1 "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-6 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

the component metadata for the form viewer for the specified type.

#### Implementation of[​](#implementation-of-5 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`get`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#get)

***

### getCssLoaders()[​](#getcssloaders "Direct link to getCssLoaders()")

> **getCssLoaders**(`biDi`): () => `Promise`<`void`>\[]

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### biDi[​](#bidi "Direct link to biDi")

[`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi)

the BiDi object for which to retrieve the CSS loaders.

#### Returns[​](#returns-7 "Direct link to Returns")

() => `Promise`<`void`>\[]

the array containing the CSS loaders for the specified BiDi.

#### Implementation of[​](#implementation-of-6 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`getCssLoaders`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#getcssloaders)

***

### withCssLoader()[​](#withcssloader "Direct link to withCssLoader()")

> **withCssLoader**(`cssLoaderType`, `loader`): `View`

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### cssLoaderType[​](#cssloadertype "Direct link to cssLoaderType")

[`CssLoaderType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CssLoaderType)

the BiDi layout type, either 'common', 'ltr', or 'rtl'.

##### loader[​](#loader "Direct link to loader")

() => `Promise`<`void`>

the function that returns a Promise to load CSS or other required localization resources.

#### Returns[​](#returns-8 "Direct link to Returns")

`View`

the View instance.

#### Implementation of[​](#implementation-of-7 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`withCssLoader`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#withcssloader)

***

### withViewerWrapper()[​](#withviewerwrapper "Direct link to withViewerWrapper()")

> **withViewerWrapper**(`wrapper`): `View`

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### wrapper[​](#wrapper "Direct link to wrapper")

[`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)

the viewer wrapper to be added. The wrapper is a component that wraps the form viewer.

#### Returns[​](#returns-9 "Direct link to Returns")

`View`

the View instance.

#### Implementation of[​](#implementation-of-8 "Direct link to Implementation of")

[`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView).[`withViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView#withviewerwrapper)

***

### create()[​](#create "Direct link to create()")

> `static` **create**(`models`): `View`

Static wrapper for the View constructor.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### models[​](#models-1 "Direct link to models")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

the components metadata.

#### Returns[​](#returns-10 "Direct link to Returns")

`View`

the View instance.


---

# Enumeration: BiDi

The enumeration of bidirectional text layout types.

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### LTR[​](#ltr "Direct link to LTR")

> **LTR**: `"ltr"`

Left to right.

***

### RTL[​](#rtl "Direct link to RTL")

> **RTL**: `"rtl"`

Right to left.


---

# Enumeration: PersistedFormVersion

The version of the saved form.

## Enumeration Members[​](#enumeration-members "Direct link to Enumeration Members")

### version1[​](#version1 "Direct link to version1")

> **version1**: `"1"`


---

# Function: buildForm()

> **buildForm**(`options?`): [`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

Creates and returns a new form JSON builder instance.

## Parameters[​](#parameters "Direct link to Parameters")

### options?[​](#options "Direct link to options?")

[`FormOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormOptions)

the optional configuration options for the form.

## Returns[​](#returns "Direct link to Returns")

[`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

the instance of [IFormJsonBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder) to start building the form.


---

# Function: calculatePropertyValue()

> **calculatePropertyValue**(`componentProperty`, `formViewerData`): [`CalculableResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/CalculableResult)

**`Internal`**

Calculates the value for the component property. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### componentProperty[​](#componentproperty "Direct link to componentProperty")

[`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)

the component property.

### formViewerData[​](#formviewerdata "Direct link to formViewerData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the formViewerData data.

## Returns[​](#returns "Direct link to Returns")

[`CalculableResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/CalculableResult)

the calculated value.


---

# Function: camelCase()

> **camelCase**(`input`): `string`

Convert a string to camelCase.

## Parameters[​](#parameters "Direct link to Parameters")

### input[​](#input "Direct link to input")

`string`

the input string.

## Returns[​](#returns "Direct link to Returns")

`string`

the camelCased string.


---

# Function: checkSlotCondition()

> **checkSlotCondition**(`childStore`, `parentProps`): `boolean`

Performs the function of checking if the child component can be bound. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### childStore[​](#childstore "Direct link to childStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the child component settings.

### parentProps[​](#parentprops "Direct link to parentProps")

`any`

the parent component properties.

## Returns[​](#returns "Direct link to Returns")

`boolean`

true, if the child component can be bound, false otherwise.


---

# Function: cloneDeep()

> **cloneDeep**<`T`>(`value`, `weakMap`): `T`

Creates a deep cloned copy of the provided value.

* Preserves prototypes for objects and class instances.
* Copies Maps, Sets, Dates, RegExps, ArrayBuffers/TypedArrays.
* Handles circular references via an internal WeakMap.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`T`

the value to deep-clone.

### weakMap[​](#weakmap "Direct link to weakMap")

`WeakMap`<`object`, `any`> = `...`

internal map to track circular references (do not pass in normal use).

## Returns[​](#returns "Direct link to Returns")

`T`

a deep-cloned value structurally equal to the input.


---

# Function: ComponentTree()

> **ComponentTree**(`props`): `Element`

The React component that displays an array of ComponentData. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`ComponentTreeProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentTreeProps)

the React component properties.

## Returns[​](#returns "Direct link to Returns")

`Element`

the React element.


---

# Function: createActionValuesFromObject()

> **createActionValuesFromObject**(`obj`): [`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

Converts the input object to an ActionValues object. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### obj[​](#obj "Direct link to obj")

`any`

the input object.

## Returns[​](#returns "Direct link to Returns")

[`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

the converted ActionValues object.


---

# Function: createNonNullableContext()

> **createNonNullableContext**<`T`>(`name`, `defaultValue`): \[() => `T`, `Provider`<`T`>, `Context`<`null` | `T`>]

Creates non-nullable React context. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

## Parameters[​](#parameters "Direct link to Parameters")

### name[​](#name "Direct link to name")

`string`

the context name.

### defaultValue[​](#defaultvalue "Direct link to defaultValue")

the optional default value.

`null` | `T`

## Returns[​](#returns "Direct link to Returns")

\[() => `T`, `Provider`<`T`>, `Context`<`null` | `T`>]

the tuple \[hook, provider, and common context] for interactions with a non-nullable context.


---

# Function: createProperty()

> **createProperty**(`editor`): [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`>

Creates an instance of the builder class to define the property's metadata.

## Parameters[​](#parameters "Direct link to Parameters")

### editor[​](#editor "Direct link to editor")

`string`

editor type for editing the property.

## Returns[​](#returns "Direct link to Returns")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`>

the instance of the builder class to define the property's metadata.


---

# Function: debounce()

> **debounce**<`T`>(`fn`, `wait`): (...`args`) => `void` | `ReturnType`<`T`>

Debounce function calls with a timeout.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* (...`args`) => `any`

## Parameters[​](#parameters "Direct link to Parameters")

### fn[​](#fn "Direct link to fn")

`T`

the function to debounce.

### wait[​](#wait "Direct link to wait")

`number` = `0`

the delay in ms.

## Returns[​](#returns "Direct link to Returns")

the debounced function.

> (...`args`): `void` | `ReturnType`<`T`>

### Parameters[​](#parameters-1 "Direct link to Parameters")

#### args[​](#args "Direct link to args")

...`Parameters`<`T`>

### Returns[​](#returns-1 "Direct link to Returns")

`void` | `ReturnType`<`T`>


---

# Function: findLanguage()

> **findLanguage**(`languages`, `language`): `undefined` | [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

Finds [Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language) by language code.

## Parameters[​](#parameters "Direct link to Parameters")

### languages[​](#languages "Direct link to languages")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)\[]

the array of languages to look in.

### language[​](#language "Direct link to language")

`` `${string}-${string}` ``

the language code.

## Returns[​](#returns "Direct link to Returns")

`undefined` | [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

found [Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language), or the default Language if no Language exists for the language code.


---

# Function: findTreeElementDepth()

> **findTreeElementDepth**<`T`>(`value`, `element?`, `depth?`): `undefined` | `number`

Finds the depth of a given element in a tree. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object`

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`T`

the root of the tree.

### element?[​](#element "Direct link to element?")

`T`

the element to find the depth of.

### depth?[​](#depth "Direct link to depth?")

`number` = `0`

the current depth of the tree (optional, default is 0).

## Returns[​](#returns "Direct link to Returns")

`undefined` | `number`

the depth of the element in the tree, or undefined if the element is not found.


---

# Function: fn()

> **fn**(`fnDescriptionBegin`, `fnDescriptionEnd`): [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`>

The annotation builder for a component property with type 'function'.

## Parameters[​](#parameters "Direct link to Parameters")

### fnDescriptionBegin[​](#fndescriptionbegin "Direct link to fnDescriptionBegin")

`string`

the beginning of function description.

### fnDescriptionEnd[​](#fndescriptionend "Direct link to fnDescriptionEnd")

`string` = `'}'`

the ending of function description.

## Returns[​](#returns "Direct link to Returns")

[`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`>

the annotation builder for a component property with type 'function'.

## Example[​](#example "Direct link to Example")

```
// Example usage with TSDoc-style function description:
fn(
  `/**
    * @param {string} value
    * @param {ItemDataType} item
    * @return {boolean}
    */
  function filterBy(value, item) {`
)
```

This will create a function property with proper type hints and documentation that describes a filter function taking a string and an item, returning a boolean.


---

# Function: forwardRef()

> **forwardRef**<`T`, `P`>(`render`): `ForwardRefExoticComponent`<`P`> | `ForwardRefExoticComponent`<`PropsWithoutRef`<`P`> & `RefAttributes`<`T`>>

Shim to be compatible with React 19.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

### P[​](#p "Direct link to P")

`P` = `Record`<`string`, `unknown`>

## Parameters[​](#parameters "Direct link to Parameters")

### render[​](#render "Direct link to render")

`ForwardRefRenderFunction`<`T`, `P` & `object`>

the forward ref render function.

## Returns[​](#returns "Direct link to Returns")

`ForwardRefExoticComponent`<`P`> | `ForwardRefExoticComponent`<`PropsWithoutRef`<`P`> & `RefAttributes`<`T`>>

the React component.


---

# Function: generateTemplateTypeName()

> **generateTemplateTypeName**(`name`): `string`

Generates the template type name from the specified template name. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### name[​](#name "Direct link to name")

`string`

the template name.

## Returns[​](#returns "Direct link to Returns")

`string`

the template type name.


---

# Function: generateUniqueName()

> **generateUniqueName**(`prefix`, `existingNames`): `string`

Generates a unique name with the specified prefix. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### prefix[​](#prefix "Direct link to prefix")

`string`

the prefix.

### existingNames[​](#existingnames "Direct link to existingNames")

`Set`<`string`>

the set of existing names to match with which uniqueness will be checked.

## Returns[​](#returns "Direct link to Returns")

`string`

the generated name.


---

# Function: getChildren()

> **getChildren**(`data`, `componentTreeItem`, `componentProps`): `Record`<`string`, `any`>

Returns the Record with all child components. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### data[​](#data "Direct link to data")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the parent component's data necessary to display the component.

### componentTreeItem[​](#componenttreeitem "Direct link to componentTreeItem")

`ComponentType`<[`ComponentTreeProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentTreeProps)>

the type of React component that wraps child components.

### componentProps[​](#componentprops "Direct link to componentProps")

`Record`<`string`, `any`>

the properties of the parent component.

## Returns[​](#returns "Direct link to Returns")

`Record`<`string`, `any`>

the Record with all child components.


---

# Function: getDefault()

> **getDefault**(`annotations`): `Readonly`<`Record`<`string`, `any`>>

Extracts component properties default values from annotations . **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### annotations[​](#annotations "Direct link to annotations")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the array of component annotations.

## Returns[​](#returns "Direct link to Returns")

`Readonly`<`Record`<`string`, `any`>>

the object containing component properties default values.


---

# Function: getDefaultCss()

> **getDefaultCss**(`annotations`): `Readonly`<`Record`<`string`, `any`>>

Extracts CSS properties default values from annotations . **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### annotations[​](#annotations "Direct link to annotations")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the array of component annotations.

## Returns[​](#returns "Direct link to Returns")

`Readonly`<`Record`<`string`, `any`>>

the object with CSS properties default values.


---

# Function: getEditableFormData()

> **getEditableFormData**(`form`): `Record`<`string`, `unknown`>

Replaces empty form fields with an empty string. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### form[​](#form "Direct link to form")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form.

## Returns[​](#returns "Direct link to Returns")

`Record`<`string`, `unknown`>

all form data where empty fields are filled with empty strings.


---

# Function: getKey()

> **getKey**(): `string`

Generates the random string. **Internal use only.**

## Returns[​](#returns "Direct link to Returns")

`string`

the generated random string.


---

# Function: getTemplateName()

> **getTemplateName**(`typeName`): `string`

Extracts the template name from the specified component type name. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### typeName[​](#typename "Direct link to typeName")

`string`

the component type name.

## Returns[​](#returns "Direct link to Returns")

`string`

the template name.


---

# Function: getValidatorPropertyBlockType()

> **getValidatorPropertyBlockType**(`ruleKey`): `string`

Retrieves the property block type for a given rule key. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### ruleKey[​](#rulekey "Direct link to ruleKey")

`string`

the rule key.

## Returns[​](#returns "Direct link to Returns")

`string`

the property block type. Validator property block types are prefixed with 'validator-'.


---

# Function: groupBy()

> **groupBy**<`T`>(`array`, `predicate`): `Record`<`string`, `T`\[]>

Groups the array of values by function predicate. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

## Parameters[​](#parameters "Direct link to Parameters")

### array[​](#array "Direct link to array")

`T`\[]

the array of values.

### predicate[​](#predicate "Direct link to predicate")

(`value`, `index`, `array`) => `string`

the function that returns a string to group the values of the array.

## Returns[​](#returns "Direct link to Returns")

`Record`<`string`, `T`\[]>

the Record with grouped values.


---

# Function: isContainer()

> **isContainer**(`value`): `value is ContainerAnnotation`

Type predicate, asserts that the value is an instance of ContainerAnnotation. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the value.

## Returns[​](#returns "Direct link to Returns")

`value is ContainerAnnotation`

true if the value is an instance of ContainerAnnotation, false otherwise.


---

# Function: isEmpty()

> **isEmpty**(`value`): `boolean`

Generic emptiness check for strings, arrays, maps/sets and objects.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`unknown`

input value.

## Returns[​](#returns "Direct link to Returns")

`boolean`

true if considered empty.


---

# Function: isEqual()

> **isEqual**<`T`>(`a`, `b`): `boolean`

Naive deep equality via JSON serialization.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

## Parameters[​](#parameters "Direct link to Parameters")

### a[​](#a "Direct link to a")

`T`

the first value.

### b[​](#b "Direct link to b")

`T`

the second value.

## Returns[​](#returns "Direct link to Returns")

`boolean`

the equality result.


---

# Function: isEqualWith()

> **isEqualWith**(`a`, `b`, `customizer?`): `boolean`

Deep equality with optional customizer short-circuiting element-wise.

## Parameters[​](#parameters "Direct link to Parameters")

### a[​](#a "Direct link to a")

`unknown`

the first value.

### b[​](#b "Direct link to b")

`unknown`

the second value.

### customizer?[​](#customizer "Direct link to customizer?")

(`a`, `b`, `key?`) => `undefined` | `boolean`

the optional comparator callback.

## Returns[​](#returns "Direct link to Returns")

`boolean`

the equality result.


---

# Function: isFunctionalProperty()

> **isFunctionalProperty**(`componentProperty?`): `boolean`

Returns true if the property value is calculated by the function, otherwise false. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### componentProperty?[​](#componentproperty "Direct link to componentProperty?")

[`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)<`any`>

the component property.

## Returns[​](#returns "Direct link to Returns")

`boolean`

true if the property value is calculated by the function, otherwise false.


---

# Function: isLocalizedProperty()

> **isLocalizedProperty**(`componentProperty?`): `boolean`

Returns true if the property value is localized, otherwise false. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### componentProperty?[​](#componentproperty "Direct link to componentProperty?")

[`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)<`any`>

the component property.

## Returns[​](#returns "Direct link to Returns")

`boolean`

true if the property value is localized, otherwise false.


---

# Function: isNull()

> **isNull**(`value`): `value is null`

Returns true if value is strictly null.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`unknown`

the input value.

## Returns[​](#returns "Direct link to Returns")

`value is null`

boolean indicating null.


---

# Function: isNumber()

> **isNumber**(`value`): `value is number`

Returns true if value is a number (NaN and Infinity included).

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`unknown`

input value.

## Returns[​](#returns "Direct link to Returns")

`value is number`

boolean indicating number.


---

# Function: isObject()

> **isObject**(`value`): `value is Record<string, unknown>`

Type guard: true if value is a non-null object.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`unknown`

input value.

## Returns[​](#returns "Direct link to Returns")

`value is Record<string, unknown>`

boolean indicating object.


---

# Function: isPromise()

> **isPromise**<`T`>(`value`): `value is Promise<T>`

Type predicate, asserts that the value is a Promise. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` = `any`

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`any`

the value.

## Returns[​](#returns "Direct link to Returns")

`value is Promise<T>`

true if the value is a Promise, false otherwise.


---

# Function: isProperty()

> **isProperty**(`value`): `value is PropertyAnnotation`

Type predicate, asserts that the value is an instance of PropertyAnnotation. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

the value.

## Returns[​](#returns "Direct link to Returns")

`value is PropertyAnnotation`

true if the value is an instance of PropertyAnnotation, false otherwise.


---

# Function: isString()

> **isString**(`value`): `value is string`

Type predicate, asserts that the value is a string. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`any`

the value.

## Returns[​](#returns "Direct link to Returns")

`value is string`

true if the value is a string, false otherwise.


---

# Function: isTemplateType()

> **isTemplateType**(`typeName`): `boolean`

Returns true if typeName is the template type, false otherwise. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### typeName[​](#typename "Direct link to typeName")

`string`

the type name.

## Returns[​](#returns "Direct link to Returns")

`boolean`

true if typeName is the template type, false otherwise.


---

# Function: isUndefined()

> **isUndefined**(`value`): `value is undefined`

Returns true if value is strictly undefined.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`unknown`

the input value.

## Returns[​](#returns "Direct link to Returns")

`value is undefined`

boolean indicating undefined.


---

# Function: isValidatorPropertyBlockType()

> **isValidatorPropertyBlockType**(`type`): `boolean`

Determines if the given type is a validator property block type. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### type[​](#type "Direct link to type")

`string`

the type to be checked.

## Returns[​](#returns "Direct link to Returns")

`boolean`

the boolean value indicating if the type is a validator property block type.


---

# Function: loadResource()

> **loadResource**(`id`, `href`, `rel`): `Promise`<`void`>

Loads a resource into the document head asynchronously. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### id[​](#id "Direct link to id")

`string`

the identifier of the resource.

### href[​](#href "Direct link to href")

`string`

represents a URL to the resource.

### rel[​](#rel "Direct link to rel")

`string`

the relationship of the resource to the document.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`>

the promise that resolves when the resource has been loaded successfully.


---

# Function: merge()

> **merge**<`T`>(`target`, ...`sources`): `T`

Deep merge plain objects left-to-right.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object`

## Parameters[​](#parameters "Direct link to Parameters")

### target[​](#target "Direct link to target")

`T`

the target object.

### sources[​](#sources "Direct link to sources")

...`any`\[]

the additional sources.

## Returns[​](#returns "Direct link to Returns")

`T`

the merged target.


---

# Function: nameAutorun()

> **nameAutorun**(`owner`, `name`, `params`): `string`

Computes the autorun name based on the owner, name, and parameters. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### owner[​](#owner "Direct link to owner")

`string`

the owner of the autorun.

### name[​](#name "Direct link to name")

`string`

the name of the autorun.

### params[​](#params "Direct link to params")

`Record`<`string`, `any`> = `{}`

the parameters for specific autorun.

## Returns[​](#returns "Direct link to Returns")

`string`

the computed autorun name.


---

# Function: namedObserver()

> **namedObserver**<`T`>(`displayName`, `component`): `T`

Creates the observable React component. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `ComponentType`<`any`>

## Parameters[​](#parameters "Direct link to Parameters")

### displayName[​](#displayname "Direct link to displayName")

`string`

the displayName value of the React component.

### component[​](#component "Direct link to component")

`T`

the React component.

## Returns[​](#returns "Direct link to Returns")

`T`

the observable React component.


---

# Function: nameObservable()

> **nameObservable**(`owner`, `params`): `string`

Computes the observable name based on the owner, name, and parameters. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### owner[​](#owner "Direct link to owner")

`string`

the owner of the observable.

### params[​](#params "Direct link to params")

`Record`<`string`, `any`> = `{}`

the parameters for specific observable.

## Returns[​](#returns "Direct link to Returns")

`string`

the computed observable name.


---

# Function: needRender()

> **needRender**(`componentStore`, `formData`): `boolean`

Returns true if the component should be rendered, false otherwise.

## Parameters[​](#parameters "Direct link to Parameters")

### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

### formData[​](#formdata "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data.

## Returns[​](#returns "Direct link to Returns")

`boolean`

true if the component should be rendered, false otherwise.


---

# Function: startCase()

> **startCase**(`input`): `string`

Convert a string to Start Case.

## Parameters[​](#parameters "Direct link to Parameters")

### input[​](#input "Direct link to input")

`string`

the input string.

## Returns[​](#returns "Direct link to Returns")

`string`

the start-cased string.


---

# Function: SuppressResizeObserverErrors()

> **SuppressResizeObserverErrors**(`props`): `Element`

SuppressResizeObserverErrors component is used to suppress ResizeObserver errors. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`SuppressResizeObserverErrorsProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/SuppressResizeObserverErrorsProps)

the component props.

## Returns[​](#returns "Direct link to Returns")

`Element`

the rendered child elements.


---

# Function: toArray()

> **toArray**<`T`>(`annotations?`, `setup?`): [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

Converts the object containing component property metadata into an array. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object` = `any`

## Parameters[​](#parameters "Direct link to Parameters")

### annotations?[​](#annotations "Direct link to annotations?")

[`Annotations`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)<`T`>

the object containing component property metadata.

### setup?[​](#setup "Direct link to setup?")

[`BuilderSetup`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup) = `{}`

the custom options for the component's property metadata builder.

## Returns[​](#returns "Direct link to Returns")

[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)\[]

the metadata array of the component properties.


---

# Function: toLabeledValues()

> **toLabeledValues**(`items`, `upper`): [`LabeledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue)\[]

Converts the array of elements into the array of [LabeledValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue) elements.

## Parameters[​](#parameters "Direct link to Parameters")

### items[​](#items "Direct link to items")

(`string` | `number` | [`LabeledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue))\[]

the array of elements.

### upper[​](#upper "Direct link to upper")

`boolean` = `true`

if true, the first character in [LabeledValue.label](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue#label) will be capitalized.

## Returns[​](#returns "Direct link to Returns")

[`LabeledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue)\[]

the array of [LabeledValue](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue) elements.


---

# Function: toUpper()

> **toUpper**(`input`): `string`

Uppercase wrapper guarding falsy input.

## Parameters[​](#parameters "Direct link to Parameters")

### input[​](#input "Direct link to input")

`string`

the input string.

## Returns[​](#returns "Direct link to Returns")

`string`

the uppercased string.


---

# Function: treeForEach()

> **treeForEach**<`T`>(`tree`, `fn`): `void`

Executes a given function on each node of a tree. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object`

## Parameters[​](#parameters "Direct link to Parameters")

### tree[​](#tree "Direct link to tree")

`T`

the root node of the tree.

### fn[​](#fn "Direct link to fn")

(`treeNode`) => `void`

the function to be executed on each node of the tree.

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Function: uniqueId()

> **uniqueId**(`prefix`): `string`

Create an incrementing unique id string with optional prefix.

## Parameters[​](#parameters "Direct link to Parameters")

### prefix[​](#prefix "Direct link to prefix")

`string` = `''`

the optional prefix.

## Returns[​](#returns "Direct link to Returns")

`string`

the unique id string.


---

# Function: unloadResource()

> **unloadResource**(`id`): `void`

Unloads a resource from the DOM based on its ID. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### id[​](#id "Direct link to id")

`string`

the ID of the resource to unload.

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Function: upperFirst()

> **upperFirst**(`input`): `string`

Uppercase the first character of a string.

## Parameters[​](#parameters "Direct link to Parameters")

### input[​](#input "Direct link to input")

`string`

input string.

## Returns[​](#returns "Direct link to Returns")

`string`

string with first char uppercased.


---

# Function: useAriaAttributes()

> **useAriaAttributes**(`options`): `object`

## Parameters[​](#parameters "Direct link to Parameters")

### options[​](#options "Direct link to options")

[`AriaAttributesOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesOptions)

options for configuring the generation of ARIA attributes.

## Returns[​](#returns "Direct link to Returns")

`object`

a record with 'aria' attributes.

### aria-errormessage[​](#aria-errormessage "Direct link to aria-errormessage")

> **aria-errormessage**: `string`

### aria-invalid[​](#aria-invalid "Direct link to aria-invalid")

> **aria-invalid**: `boolean` = `error`

### aria-labelledby[​](#aria-labelledby "Direct link to aria-labelledby")

> **aria-labelledby**: `string`


---

# Function: useAriaAttributesIds()

> **useAriaAttributesIds**(`options`): [`AriaAttributesIds`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesIds)

## Parameters[​](#parameters "Direct link to Parameters")

### options[​](#options "Direct link to options")

[`AriaAttributesOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesOptions)

options for configuring the generation of ARIA attributes.

## Returns[​](#returns "Direct link to Returns")

[`AriaAttributesIds`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesIds)

a map of aria attributes ids.


---

# Function: useAriaErrorMessage()

> **useAriaErrorMessage**(): `object`

## Returns[​](#returns "Direct link to Returns")

`object`

a record with an 'aria-errormessage' attribute.

### aria-errormessage[​](#aria-errormessage "Direct link to aria-errormessage")

> **aria-errormessage**: `string`


---

# Function: useAriaInvalid()

> **useAriaInvalid**(): `object`

## Returns[​](#returns "Direct link to Returns")

`object`

a record with an 'aria-invalid' attribute.

### aria-invalid[​](#aria-invalid "Direct link to aria-invalid")

> **aria-invalid**: `boolean` = `error`


---

# Function: useBuilderComponent()

> **useBuilderComponent**<`T`>(`builderComponent`, `viewerComponent`): `ComponentType`<`T`>

Returns a React component based on the current builder mode.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

## Parameters[​](#parameters "Direct link to Parameters")

### builderComponent[​](#buildercomponent "Direct link to builderComponent")

`ComponentType`<`T`>

the component to use in the 'builder' mode.

### viewerComponent[​](#viewercomponent "Direct link to viewerComponent")

`ComponentType`<`T`>

the component to use in the 'viewer' mode.

## Returns[​](#returns "Direct link to Returns")

`ComponentType`<`T`>

the React component based on the current builder mode.


---

# Function: useBuilderValue()

> **useBuilderValue**<`T`>(`value`, `builderValue`): `T`

Returns the value to use in the builder mode.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`T`

the value.

### builderValue[​](#buildervalue "Direct link to builderValue")

`T`

the value to be used if the value is not defined is an empty string or a string containing only spaces.

## Returns[​](#returns "Direct link to Returns")

`T`

the value to use in the builder mode.


---

# Function: useDisposable()

> **useDisposable**<`T`>(`factory`): `undefined` | `T`

Creates a disposable object and dispose the object when the React component is unmounted. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* [`IDisposable`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/IDisposable)

## Parameters[​](#parameters "Direct link to Parameters")

### factory[​](#factory "Direct link to factory")

() => `T`

the factory function to create a disposable object.

## Returns[​](#returns "Direct link to Returns")

`undefined` | `T`

the disposable object.


---

# Function: useErrorMessage()

> **useErrorMessage**(): `undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `string`

a field validation error message if the field data is not valid.


---

# Function: useErrorModel()

> **useErrorModel**(): [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)>

## Returns[​](#returns "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)>

the model of React component used to display the error.


---

# Function: useMobxConfig()

> **useMobxConfig**(): `void`

Disables the `enforceActions` check for `mobx`, so that the state can be changed from anywhere.

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Function: useModalComponentData()

> **useModalComponentData**(`parentComponentData`, `modalType`): [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

Generates the [ComponentData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData) for the modal component.

## Parameters[​](#parameters "Direct link to Parameters")

### parentComponentData[​](#parentcomponentdata "Direct link to parentComponentData")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the modal's parent component.

### modalType[​](#modaltype "Direct link to modalType")

`string`

the modal type.

## Returns[​](#returns "Direct link to Returns")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the generated [ComponentData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData) for the modal component.


---

# Function: useModalType()

> **useModalType**(): `undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `string`

the type name of the React component used to display the modal. **Internal use only.**


---

# Function: useTooltipType()

> **useTooltipType**(): `undefined` | `string`

## Returns[​](#returns "Direct link to Returns")

`undefined` | `string`

the type of React component used to display the tooltip. **Internal use only.**


---

# Interface: BaseCompilationResult

The result of compiling of anything. **Internal use only.**

## Properties[​](#properties "Direct link to Properties")

### error[​](#error "Direct link to error")

> **error**: `boolean`

Flag if true - compilation failed, false otherwise.

***

### exceptions?[​](#exceptions "Direct link to exceptions?")

> `optional` **exceptions**: `Error`\[]

The array of compilation errors.


---

# Interface: BuilderComponent

Description of the React component that connects to the form builder. Contains metadata for the form builder and metadata for the form viewer.

## Properties[​](#properties "Direct link to Properties")

### category?[​](#category "Direct link to category?")

> `readonly` `optional` **category**: `string`

The name of the component category in the designer.

***

### meta[​](#meta "Direct link to meta")

> `readonly` **meta**: [`Meta`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta)

The component metadata for the form builder.

***

### model[​](#model "Direct link to model")

> `readonly` **model**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

The component metadata for the form viewer.


---

# Interface: ComponentField

Describes the field of the component.

## Properties[​](#properties "Direct link to Properties")

### dataKey[​](#datakey "Direct link to dataKey")

> **dataKey**: `string`

The component data key.

***

### field[​](#field "Direct link to field")

> **field**: [`Field`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Field)

The component field.


---

# Interface: ComponentMetadataEventListeners

Component metadata event listeners.

## Properties[​](#properties "Direct link to Properties")

### onCreateNode()?[​](#oncreatenode "Direct link to onCreateNode()?")

> `optional` **onCreateNode**: (`node`, `store`) => `void`

The callback function that is called when a component is created and added to a form.

#### Parameters[​](#parameters "Direct link to Parameters")

##### node[​](#node "Direct link to node")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the created component data.

##### store[​](#store "Direct link to store")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)

the form viewer settings.

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### onSelectNode()?[​](#onselectnode "Direct link to onSelectNode()?")

> `optional` **onSelectNode**: (`node`, `self`) => `void`

The callback function that is called when the component is selected.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the selected component data.

##### self[​](#self "Direct link to self")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the component data.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`


---

# Interface: ComponentProperty\<T>

The value of the component property.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` = `any`

the value type.

## Properties[​](#properties "Direct link to Properties")

### computeType?[​](#computetype "Direct link to computeType?")

> `optional` **computeType**: [`ComponentPropertyComputeType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyComputeType)

Type of the component's calculated property. If not specified - the value from value is used.

***

### editorType?[​](#editortype "Direct link to editorType?")

> `optional` **editorType**: `string`

The component property editor type, only used in Designer mode.

***

### fnSource?[​](#fnsource "Direct link to fnSource?")

> `optional` **fnSource**: `string`

Source code of the function for calculating the value of a component property.

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `T`

The simple value of a component property.


---

# Interface: ComponentTreeProps

Properties of a form component tree element.

## Properties[​](#properties "Direct link to Properties")

### componentDataViewer?[​](#componentdataviewer "Direct link to componentDataViewer?")

> `optional` **componentDataViewer**: `ComponentType`

The component displaying an item.

***

### data[​](#data "Direct link to data")

> **data**: [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)\[]

An array of child elements of the tree.


---

# Interface: Definer\<T>

The builder class to define the metadata of the form builder component.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object`

React component property type.

## Properties[​](#properties "Direct link to Properties")

### data[​](#data "Direct link to data")

> **data**: [`DefinerData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DefinerData)<`T`>

Definer class data.

#### Template[​](#template "Direct link to Template")

React component property type.

## Methods[​](#methods "Direct link to Methods")

### actions()[​](#actions "Direct link to actions()")

> **actions**(`fn`): `Definer`<`T`>

Adds the metadata of the component's actions. **Internal use only.**

#### Parameters[​](#parameters "Direct link to Parameters")

##### fn[​](#fn "Direct link to fn")

[`ActionsInitializer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionsInitializer)

the function that initializes an actions on a component.

#### Returns[​](#returns "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### addFeature()[​](#addfeature "Direct link to addFeature()")

> **addFeature**(`name`, `value`): `Definer`<`T`>

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

##### value[​](#value "Direct link to value")

`unknown`

#### Returns[​](#returns-1 "Direct link to Returns")

`Definer`<`T`>

***

### build()[​](#build "Direct link to build()")

> **build**(): [`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)

Creates component metadata for the form builder and form viewer.

#### Returns[​](#returns-2 "Direct link to Returns")

[`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)

component metadata for the form builder and form viewer.

***

### category()[​](#category "Direct link to category()")

> **category**(`category`): `Definer`<`T`>

Sets the category of the component.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### category[​](#category-1 "Direct link to category")

`string`

the component category.

#### Returns[​](#returns-3 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### componentRole()[​](#componentrole "Direct link to componentRole()")

> **componentRole**(`value`): `Definer`<`T`>

Sets the role (e.g., label, tooltip, etc.) for the component.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`string`

the component role.

#### Returns[​](#returns-4 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### css()[​](#css "Direct link to css()")

> **css**(`css`): `Definer`<`T`>

Sets the component CSS metadata.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### css[​](#css-1 "Direct link to css")

[`Annotations`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)<`CSSObject`>

the component CSS metadata.

#### Returns[​](#returns-5 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### disableRemove()[​](#disableremove "Direct link to disableRemove()")

> **disableRemove**(`value`): `Definer`<`T`>

Prevent this component from being removed.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`boolean` = `true`

true to disable removal, false otherwise.

#### Returns[​](#returns-6 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### eventListeners()[​](#eventlisteners "Direct link to eventListeners()")

> **eventListeners**(`eventListeners?`): `Definer`<`T`>

Sets the component metadata event listeners.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### eventListeners?[​](#eventlisteners-1 "Direct link to eventListeners?")

[`ComponentMetadataEventListeners`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners)

the component metadata event listeners.

#### Returns[​](#returns-7 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### getType()[​](#gettype "Direct link to getType()")

> **getType**(): `string`

#### Returns[​](#returns-8 "Direct link to Returns")

`string`

the component type name.

***

### hideActionEditors()[​](#hideactioneditors "Direct link to hideActionEditors()")

> **hideActionEditors**(`value`): `Definer`<`T`>

Hides or shows the 'Actions' editors.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

`boolean` = `true`

if the value is true, the editors will be hidden.

#### Returns[​](#returns-9 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### hideFromComponentPalette()[​](#hidefromcomponentpalette "Direct link to hideFromComponentPalette()")

> **hideFromComponentPalette**(`value`): `Definer`<`T`>

Hides a component from the component palette.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### value[​](#value-4 "Direct link to value")

`boolean` = `true`

true to hide the component, false otherwise.

#### Returns[​](#returns-10 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### hideTooltipEditor()[​](#hidetooltipeditor "Direct link to hideTooltipEditor()")

> **hideTooltipEditor**(`value`): `Definer`<`T`>

Show or hide 'Tooltip' properties editor.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### value[​](#value-5 "Direct link to value")

`boolean` = `true`

if the value is `false` or `undefined`, the editor will be displayed.

#### Returns[​](#returns-11 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### icon()[​](#icon "Direct link to icon()")

> **icon**(`icon`): `Definer`<`T`>

Sets the icon of the component.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### icon[​](#icon-1 "Direct link to icon")

the component icon or the icon name.

`"Breadcrumb"` | `"Button"` | `"Card"` | `"Checkbox"` | `"CollectionEditor"` | `"Container"` | `"Content"` | `"CustomBlock"` | `"CustomControl"` | `"DatePicker"` | `"Default"` | `"Dropdown"` | `"Dropzone"` | `"ErrorMessage"` | `"Grid"` | `"GridLayout"` | `"GridView"` | `"Image"` | `"Input"` | `"Label"` | `"Link"` | `"Footer"` | `"Header"` | `"Sidebar"` | `"Menu"` | `"Message"` | `"NumberFormat"` | `"PatternFormat"` | `"ProgressCircle"` | `"ProgressLine"` | `"RadioGroup"` | `"Repeater"` | `"RichTextEditor"` | `"Search"` | `"Signature"` | `"Sparks"` | `"StaticContent"` | `"Tab"` | `"TextArea"` | `"TimePicker"` | `"Toggle"` | `"Tooltip"` | `"TreePicker"` | `"Uploader"` | `ComponentType`

#### Returns[​](#returns-12 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### initialJson()[​](#initialjson "Direct link to initialJson()")

> **initialJson**(`initialJson?`): `Definer`<`T`>

Sets initial component JSON.

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### initialJson?[​](#initialjson-1 "Direct link to initialJson?")

`string`

the JSON source for the component (instance of [ComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore) class serialised to JSON).

#### Returns[​](#returns-13 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### insertRestriction()[​](#insertrestriction "Direct link to insertRestriction()")

> **insertRestriction**(`insertRestriction?`): `Definer`<`T`>

Sets the function that restricts the insertion of a component into another component.

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### insertRestriction?[​](#insertrestriction-1 "Direct link to insertRestriction?")

[`InsertRestrictionFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn)

the function that restricts the insertion of a component into another component.

#### Returns[​](#returns-14 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### kind()[​](#kind "Direct link to kind()")

> **kind**(`kind`): `Definer`<`T`>

Sets the kind of the component.

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### kind[​](#kind-1 "Direct link to kind")

[`ComponentKind`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKind)

the component kind.

#### Returns[​](#returns-15 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### name()[​](#name-1 "Direct link to name()")

> **name**(`name`): `Definer`<`T`>

Sets the name of the component.

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### name[​](#name-2 "Direct link to name")

`string`

the component name.

#### Returns[​](#returns-16 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### overrideEventHandlers()[​](#overrideeventhandlers "Direct link to overrideEventHandlers()")

> **overrideEventHandlers**(`eventHandlers`): `Definer`<`T`>

Overrides event handlers (for example, onChange, onBlur) that are added to the component.

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### eventHandlers[​](#eventhandlers "Direct link to eventHandlers")

`Record`<[`EventName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventName), [`ActionEventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler)>

the custom event handlers.

#### Returns[​](#returns-17 "Direct link to Returns")

`Definer`<`T`>

the modified instance of the builder.

***

### ~~preview()~~[​](#preview "Direct link to preview")

> **preview**(`customPreview`): `Definer`<`T`>

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### customPreview[​](#custompreview "Direct link to customPreview")

`ReactNode`

the custom component.

#### Returns[​](#returns-18 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

Adds the custom component to be displayed in the component list. **Internal use only.**

***

### props()[​](#props "Direct link to props()")

> **props**(`properties`): `Definer`<`T`>

Sets the metadata of the component's properties.

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### properties[​](#properties-1 "Direct link to properties")

[`Annotations`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)<`T`>

the metadata of the component's properties.

#### Returns[​](#returns-19 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### showClassNameStylesEditor()[​](#showclassnamestyleseditor "Direct link to showClassNameStylesEditor()")

> **showClassNameStylesEditor**(`value`): `Definer`<`T`>

Show or hide 'Styles for className' editor.

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### value[​](#value-6 "Direct link to value")

`boolean`

if the value is `true` or `undefined`, the editor will be displayed.

#### Returns[​](#returns-20 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### showInlineStylesEditor()[​](#showinlinestyleseditor "Direct link to showInlineStylesEditor()")

> **showInlineStylesEditor**(`value`): `Definer`<`T`>

Show or hide 'Inline styles' properties editor.

#### Parameters[​](#parameters-19 "Direct link to Parameters")

##### value[​](#value-7 "Direct link to value")

`boolean`

if the value is `true` or `undefined`, the editor will be displayed.

#### Returns[​](#returns-21 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### skipChildrenDuringFieldCollection()[​](#skipchildrenduringfieldcollection "Direct link to skipChildrenDuringFieldCollection()")

> **skipChildrenDuringFieldCollection**(`value`): `Definer`<`T`>

Hides child components from the field collection. It is used when components are dynamically added to the form, for example in the Repeater component.

#### Parameters[​](#parameters-20 "Direct link to Parameters")

##### value[​](#value-8 "Direct link to value")

`boolean` = `true`

true if the feature is enabled.

#### Returns[​](#returns-22 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### type()[​](#type "Direct link to type()")

> **type**(`type`): `Definer`<`T`>

Sets the type of the component.

#### Parameters[​](#parameters-21 "Direct link to Parameters")

##### type[​](#type-1 "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-23 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### withoutStyles()[​](#withoutstyles "Direct link to withoutStyles()")

> **withoutStyles**(`value`): `Definer`<`T`>

Disables the styling of the component.

#### Parameters[​](#parameters-22 "Direct link to Parameters")

##### value[​](#value-9 "Direct link to value")

`boolean` = `true`

true to disable the styling of the component.

#### Returns[​](#returns-24 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### withoutWrapperStyles()[​](#withoutwrapperstyles "Direct link to withoutWrapperStyles()")

> **withoutWrapperStyles**(`value`): `Definer`<`T`>

Disables the styling of the component wrapper.

#### Parameters[​](#parameters-23 "Direct link to Parameters")

##### value[​](#value-10 "Direct link to value")

`boolean` = `true`

true to disable the styling of the component wrapper.

#### Returns[​](#returns-25 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.

***

### wrapperCss()[​](#wrappercss "Direct link to wrapperCss()")

> **wrapperCss**(`css`): `Definer`<`T`>

Sets the component wrapper CSS metadata.

#### Parameters[​](#parameters-24 "Direct link to Parameters")

##### css[​](#css-2 "Direct link to css")

[`Annotations`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)<`CSSObject`>

the component wrapper CSS metadata.

#### Returns[​](#returns-26 "Direct link to Returns")

`Definer`<`T`>

the modified Definer class instance.


---

# Interface: EmbeddedFormProps

The embedded form component properties.

## Properties[​](#properties "Direct link to Properties")

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the embedded form is disabled.

***

### formName?[​](#formname "Direct link to formName?")

> `optional` **formName**: `string`

The form name ([FormViewerProps.formName](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps#formname)).

***

### options?[​](#options "Direct link to options?")

> `optional` **options**: `any`

The additional options for loading the embedded form ([FormViewerProps.formOptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps#formoptions)).

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the embedded form is read-only.

***

### storeDataInParentForm?[​](#storedatainparentform "Direct link to storeDataInParentForm?")

> `optional` **storeDataInParentForm**: `boolean`

If false, nested form data show as nested object, true otherwise.


---

# Interface: ErrorWrapperProps

Properties of the React component that wraps the form view component and displays validation errors.

## Extended by[​](#extended-by "Direct link to Extended by")

* [`RsErrorMessageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps)
* [`RsErrorMessageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps)
* [`RsErrorMessageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps)
* [`RsErrorMessageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps)

## Properties[​](#properties "Direct link to Properties")

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The wrapped component.

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

***

### error?[​](#error "Direct link to error?")

> `optional` **error**: `string`

The error text.


---

# Interface: Field

Field with the form data.

## Properties[​](#properties "Direct link to Properties")

### clear()[​](#clear "Direct link to clear()")

> **clear**: () => `void`

Clears the data in the field.

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**: () => `void`

Releases allocated resources, must be used when destroying an object instance.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### error?[​](#error "Direct link to error?")

> `optional` **error**: `string`

Contains a field validation error if the field data is not valid.

***

### errors?[​](#errors "Direct link to errors?")

> `optional` **errors**: `Record`<`string`, `unknown`> | `Record`<`string`, `unknown`>\[]

Contains a field validation errors if the field provides multiple errors (i.e. field is template). Contains an array of field validation errors if the field contains an array of components.

***

### fieldType[​](#fieldtype "Direct link to fieldType")

> **fieldType**: [`FieldType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FieldType)

The field type.

***

### getValidationResult()[​](#getvalidationresult "Direct link to getValidationResult()")

> **getValidationResult**: () => `Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) | [`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)\[]>

Returns the validation results without triggering an events and changing the state of the form.

#### Returns[​](#returns-2 "Direct link to Returns")

`Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) | [`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)\[]>

the [ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) validation results.

***

### init()[​](#init "Direct link to init()")

> **init**: () => `void`

Initializes the value of the field.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### reset()[​](#reset "Direct link to reset()")

> **reset**: () => `void`

Sets the field to its default value.

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

***

### setError()[​](#seterror "Direct link to setError()")

> **setError**: (`error`) => `void`

Sets the error value.

#### Parameters[​](#parameters "Direct link to Parameters")

##### error[​](#error-1 "Direct link to error")

`unknown`

The error value to be set.

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

***

### setTouched()[​](#settouched "Direct link to setTouched()")

> **setTouched**: () => `void`

Marks the field as touched.

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

***

### setValue()[​](#setvalue "Direct link to setValue()")

> **setValue**: (`value`) => `void`

Sets the value of the field.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`unknown`

the value.

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

***

### storeDataInParentForm?[​](#storedatainparentform "Direct link to storeDataInParentForm?")

> `optional` **storeDataInParentForm**: `boolean`

Flag, false if nested form data show as nested object, true otherwise.

***

### touched[​](#touched "Direct link to touched")

> **touched**: `boolean`

Flag, true, if the field is marked as touched.

***

### validate()[​](#validate "Direct link to validate()")

> **validate**: () => `Promise`<`void`>

Validates the field value.

#### Returns[​](#returns-8 "Direct link to Returns")

`Promise`<`void`>

***

### value[​](#value-1 "Direct link to value")

> **value**: `unknown`

Value of the field.

***

### valued[​](#valued "Direct link to valued")

> **valued**: `string`

The name of the component property that contains the field value.


---

# Interface: FormViewerProps

Form viewer React component properties.

## Properties[​](#properties "Direct link to Properties")

### actions?[​](#actions "Direct link to actions?")

> `optional` **actions**: [`CustomActions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomActions)

Custom actions for the form viewer.

***

### componentWrapper?[​](#componentwrapper "Direct link to componentWrapper?")

> `optional` **componentWrapper**: `ComponentType`<`any`>

The React component that wraps every component in a form. **Internal use only.**

***

### context?[​](#context "Direct link to context?")

> `optional` **context**: `any`

The arbitrary user context.

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the form is disabled.

***

### errors?[​](#errors "Direct link to errors?")

> `optional` **errors**: `Record`<`string`, `unknown`>

The form validation errors.

***

### errorWrapper?[​](#errorwrapper "Direct link to errorWrapper?")

> `optional` **errorWrapper**: `ComponentType`<[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)>

The default error wrapper used when errorType is not specified in the form.

***

### formName?[​](#formname "Direct link to formName?")

> `optional` **formName**: `string`

The form name. Updating the value triggers the [FormViewerProps.getForm](#getform) function.

***

### formOptions?[​](#formoptions "Direct link to formOptions?")

> `optional` **formOptions**: `any`

The form options. Used to transfer any options to the [FormViewerProps.getForm](#getform) function. Updating the value triggers the [FormViewerProps.getForm](#getform) function.

***

### formValidators?[​](#formvalidators "Direct link to formValidators?")

> `optional` **formValidators**: [`FormValidators`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidators)

The set of functions that validate the form data.

***

### getForm()?[​](#getform "Direct link to getForm()?")

> `optional` **getForm**: (`name?`, `options?`) => `string` | `Promise`<`string`>

Loads the form.

#### Parameters[​](#parameters "Direct link to Parameters")

##### name?[​](#name "Direct link to name?")

`string`

the form name.

##### options?[​](#options "Direct link to options?")

`any`

the form options.

#### Returns[​](#returns "Direct link to Returns")

`string` | `Promise`<`string`>

the string or Promise with the form.

***

### initialData?[​](#initialdata "Direct link to initialData?")

> `optional` **initialData**: `Record`<`string`, `unknown`>

The initial data of the form.

***

### language?[​](#language "Direct link to language?")

> `optional` **language**: `` `${string}-${string}` ``

The language of the form, e.g. 'en-US'.

***

### localizationEngine?[​](#localizationengine "Direct link to localizationEngine?")

> `optional` **localizationEngine**: [`ILocalizationEngine`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationEngine)

The localization engine used by the viewer.

***

### localize?[​](#localize "Direct link to localize?")

> `optional` **localize**: [`ComponentLocalizer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLocalizer)

The function to localize the properties of a component.

***

### onFormDataChange()?[​](#onformdatachange "Direct link to onFormDataChange()?")

> `optional` **onFormDataChange**: (`data`) => `void`

The event is called whenever a form data changes.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### data[​](#data "Direct link to data")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the [IFormData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData) with all the form data.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the form is read-only.

***

### showAllValidationErrors?[​](#showallvalidationerrors "Direct link to showAllValidationErrors?")

> `optional` **showAllValidationErrors**: `boolean`

If true, all validation errors will be displayed.

***

### validators?[​](#validators "Direct link to validators?")

> `optional` **validators**: `Partial`<`Record`\<keyof [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap), [`CustomValidationRules`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRules)>>

The set of metadata of validation rules, grouped by the type of value being validated.

***

### view[​](#view "Direct link to view")

> **view**: [`IView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IView)

All the metadata of the components of the form viewer.

***

### viewerRef?[​](#viewerref "Direct link to viewerRef?")

> `optional` **viewerRef**: `ForwardedRef`<[`IFormViewer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer)>

The reference to [IFormViewer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer).

***

### viewMode?[​](#viewmode "Direct link to viewMode?")

> `optional` **viewMode**: [`ViewMode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ViewMode)

Display resolution type.


---

# Interface: FormViewerWrapperComponentProps

Represents the props for the WrapperComponent. WrapperComponent is a component that wraps the form viewer. Can be added externally.

## Properties[​](#properties "Direct link to Properties")

### children[​](#children "Direct link to children")

> **children**: `ReactNode`

The React child node.

***

### language[​](#language "Direct link to language")

> **language**: [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

The FormViewer language.


---

# Interface: IComponentBuilder

Interface for configuring a specific component within the form.

## Extends[​](#extends "Direct link to Extends")

* [`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

## Extended by[​](#extended-by "Direct link to Extended by")

* [`IEventHandlerBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder)
* [`IValidationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder)

## Methods[​](#methods "Direct link to Methods")

### children()[​](#children "Direct link to children()")

> **children**(`childrenBuilder`): `IComponentBuilder`

Adds child components inside this component.

#### Parameters[​](#parameters "Direct link to Parameters")

##### childrenBuilder[​](#childrenbuilder "Direct link to childrenBuilder")

(`builder`) => [`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

the function that builds the child components.

#### Returns[​](#returns "Direct link to Returns")

`IComponentBuilder`

the component builder for method chaining.

***

### component()[​](#component "Direct link to component()")

> **component**(`key`, `type`): `IComponentBuilder`

Adds a component to the form.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique identifier of the component.

##### type[​](#type "Direct link to type")

`string`

the type of the component.

#### Returns[​](#returns-1 "Direct link to Returns")

`IComponentBuilder`

the component builder for further configuration.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder).[`component`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder#component)

***

### computedProp()[​](#computedprop "Direct link to computedProp()")

> **computedProp**(`key`, `value`): `IComponentBuilder`

Sets a computed property on the component.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the name of the property.

##### value[​](#value "Direct link to value")

`string`

the code of the function for calculating the property value.

#### Returns[​](#returns-2 "Direct link to Returns")

`IComponentBuilder`

the component builder for method chaining.

***

### event()[​](#event "Direct link to event()")

> **event**(`eventName`): [`IEventHandlerBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder)

Starts configuring an event handler for the given event name.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### eventName[​](#eventname "Direct link to eventName")

`string`

the name of the event (e.g., "onClick", "onChange").

#### Returns[​](#returns-3 "Direct link to Returns")

[`IEventHandlerBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder)

the event handler builder.

***

### json()[​](#json "Direct link to json()")

> **json**(): `string`

Serializes the current state of the form into a JSON string.

#### Returns[​](#returns-4 "Direct link to Returns")

`string`

JSON representation of the form.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder).[`json`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder#json)

***

### localizedProp()[​](#localizedprop "Direct link to localizedProp()")

> **localizedProp**(`key`, `language`, `value`): `IComponentBuilder`

Sets a localized property on the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### key[​](#key-2 "Direct link to key")

`string`

the name of the property.

##### language[​](#language "Direct link to language")

`` `${string}-${string}` ``

the localized code, e.g. 'en-US'.

##### value[​](#value-1 "Direct link to value")

`any`

the localized value of the property.

#### Returns[​](#returns-5 "Direct link to Returns")

`IComponentBuilder`

the component builder for method chaining.

***

### prop()[​](#prop "Direct link to prop()")

> **prop**(`key`, `value`): `IComponentBuilder`

Sets a property on the component.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### key[​](#key-3 "Direct link to key")

`string`

the name of the property.

##### value[​](#value-2 "Direct link to value")

`any`

the value of the property.

#### Returns[​](#returns-6 "Direct link to Returns")

`IComponentBuilder`

the component builder for method chaining.

***

### style()[​](#style "Direct link to style()")

> **style**(`value`, `device?`): `IComponentBuilder`

Applies styles to the component, optionally per device.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

the style string (e.g., "color: red") or object with style properties.

`string` | `CSSProperties`

##### device?[​](#device "Direct link to device?")

[`Device`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Device)

the optional device-specific styling.

#### Returns[​](#returns-7 "Direct link to Returns")

`IComponentBuilder`

the component builder for method chaining.

***

### validation()[​](#validation "Direct link to validation()")

> **validation**(`key`): [`IValidationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder)

Starts configuring validation rules for the specified field.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### key[​](#key-4 "Direct link to key")

`string`

the name of the validation rule.

#### Returns[​](#returns-8 "Direct link to Returns")

[`IValidationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder)

the validation builder for defining arguments.


---

# Interface: IComponentDataFactory

The factory for creating ComponentData instances. **Internal use only.**

## Methods[​](#methods "Direct link to Methods")

### createComponentData()[​](#createcomponentdata "Direct link to createComponentData()")

> **createComponentData**(`componentStore`, `deferFieldCalculation`): [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

Creates the element for the component tree. **Internal use only.**

#### Parameters[​](#parameters "Direct link to Parameters")

##### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

##### deferFieldCalculation[​](#deferfieldcalculation "Direct link to deferFieldCalculation")

`boolean`

if true, then the calculated field must be explicitly initialized.

#### Returns[​](#returns "Direct link to Returns")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the element for the component tree.


---

# Interface: IComponentState

Calculates all the properties of the form view component.

## Accessors[​](#accessors "Direct link to Accessors")

### get[​](#get "Direct link to get")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **get**(): `Record`<`string`, `any`>

##### Returns[​](#returns "Direct link to Returns")

`Record`<`string`, `any`>

combined in order of priority component properties.

***

### isDisabled[​](#isdisabled "Direct link to isDisabled")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **isDisabled**(): `boolean`

##### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

true if the component is disabled, false otherwise.

***

### isReadOnly[​](#isreadonly "Direct link to isReadOnly")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **isReadOnly**(): `boolean`

##### Returns[​](#returns-2 "Direct link to Returns")

`boolean`

true if the component is read-only, false otherwise.

***

### ownProps[​](#ownprops "Direct link to ownProps")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **ownProps**(): `Record`<`string`, `any`>

##### Returns[​](#returns-3 "Direct link to Returns")

`Record`<`string`, `any`>

combined in order of priority component properties without children props.

***

### propsWithoutChildren[​](#propswithoutchildren "Direct link to propsWithoutChildren")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **propsWithoutChildren**(): `Record`<`string`, `any`>

##### Returns[​](#returns-4 "Direct link to Returns")

`Record`<`string`, `any`>

combined component properties in order of priority, excluding child components, the className property does not contain styles additionally defined for the component.

***

### wrapperClassName[​](#wrapperclassname "Direct link to wrapperClassName")

#### Get Signature[​](#get-signature-5 "Direct link to Get Signature")

> **get** **wrapperClassName**(): `string`

Calculates and returns wrapper className property.

##### Returns[​](#returns-5 "Direct link to Returns")

`string`

the className for the wrapper of component.

***

### wrapperStyle[​](#wrapperstyle "Direct link to wrapperStyle")

#### Get Signature[​](#get-signature-6 "Direct link to Get Signature")

> **get** **wrapperStyle**(): `undefined` | { `style`: `CSSProperties`; }

##### Returns[​](#returns-6 "Direct link to Returns")

`undefined` | { `style`: `CSSProperties`; }

the Record that contains the style property for the wrapper of component.

## Methods[​](#methods "Direct link to Methods")

### onDidMount()[​](#ondidmount "Direct link to onDidMount()")

> **onDidMount**(): `void`

The method that is called when the component is mounted.

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

***

### onWillUnmount()[​](#onwillunmount "Direct link to onWillUnmount()")

> **onWillUnmount**(): `void`

The method that is called when the component is unmounted.

#### Returns[​](#returns-8 "Direct link to Returns")

`void`


---

# Interface: IDataRootProvider

Provides the root component for the data in the component tree.

## Accessors[​](#accessors "Direct link to Accessors")

### dataRoot[​](#dataroot "Direct link to dataRoot")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **dataRoot**(): [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

##### Returns[​](#returns "Direct link to Returns")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the root component for the data in the component tree.


---

# Interface: IEventHandlerBuilder

Interface for defining event handlers for a component.

## Extends[​](#extends "Direct link to Extends")

* [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

## Methods[​](#methods "Direct link to Methods")

### args()[​](#args "Direct link to args()")

> **args**(`val`): `IEventHandlerBuilder`

Specifies the arguments passed to the event handler.

#### Parameters[​](#parameters "Direct link to Parameters")

##### val[​](#val "Direct link to val")

`any`

the arguments to pass to the handler.

#### Returns[​](#returns "Direct link to Returns")

`IEventHandlerBuilder`

the event handler builder.

***

### children()[​](#children "Direct link to children()")

> **children**(`childrenBuilder`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Adds child components inside this component.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### childrenBuilder[​](#childrenbuilder "Direct link to childrenBuilder")

(`builder`) => [`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

the function that builds the child components.

#### Returns[​](#returns-1 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`children`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#children)

***

### commonAction()[​](#commonaction "Direct link to commonAction()")

> **commonAction**(`name`): `IEventHandlerBuilder`

Sets a common handler for the event.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### name[​](#name "Direct link to name")

`string`

the name of the common handler.

#### Returns[​](#returns-2 "Direct link to Returns")

`IEventHandlerBuilder`

the event handler builder.

***

### component()[​](#component "Direct link to component()")

> **component**(`key`, `type`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Adds a component to the form.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique identifier of the component.

##### type[​](#type "Direct link to type")

`string`

the type of the component.

#### Returns[​](#returns-3 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for further configuration.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`component`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#component)

***

### computedProp()[​](#computedprop "Direct link to computedProp()")

> **computedProp**(`key`, `value`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Sets a computed property on the component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the name of the property.

##### value[​](#value "Direct link to value")

`string`

the code of the function for calculating the property value.

#### Returns[​](#returns-4 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`computedProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#computedprop)

***

### customAction()[​](#customaction "Direct link to customAction()")

> **customAction**(`name`): `IEventHandlerBuilder`

Sets a custom handler for the event.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### name[​](#name-1 "Direct link to name")

`string`

the name of the custom handler function.

#### Returns[​](#returns-5 "Direct link to Returns")

`IEventHandlerBuilder`

the event handler builder.

***

### event()[​](#event "Direct link to event()")

> **event**(`eventName`): `IEventHandlerBuilder`

Starts configuring an event handler for the given event name.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### eventName[​](#eventname "Direct link to eventName")

`string`

the name of the event (e.g., "onClick", "onChange").

#### Returns[​](#returns-6 "Direct link to Returns")

`IEventHandlerBuilder`

the event handler builder.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`event`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#event)

***

### json()[​](#json "Direct link to json()")

> **json**(): `string`

Serializes the current state of the form into a JSON string.

#### Returns[​](#returns-7 "Direct link to Returns")

`string`

JSON representation of the form.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`json`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#json)

***

### localizedProp()[​](#localizedprop "Direct link to localizedProp()")

> **localizedProp**(`key`, `language`, `value`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Sets a localized property on the component.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### key[​](#key-2 "Direct link to key")

`string`

the name of the property.

##### language[​](#language "Direct link to language")

`` `${string}-${string}` ``

the localized code, e.g. 'en-US'.

##### value[​](#value-1 "Direct link to value")

`any`

the localized value of the property.

#### Returns[​](#returns-8 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`localizedProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#localizedprop)

***

### prop()[​](#prop "Direct link to prop()")

> **prop**(`key`, `value`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Sets a property on the component.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### key[​](#key-3 "Direct link to key")

`string`

the name of the property.

##### value[​](#value-2 "Direct link to value")

`any`

the value of the property.

#### Returns[​](#returns-9 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`prop`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#prop)

***

### style()[​](#style "Direct link to style()")

> **style**(`value`, `device?`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Applies styles to the component, optionally per device.

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

the style string (e.g., "color: red") or object with style properties.

`string` | `CSSProperties`

##### device?[​](#device "Direct link to device?")

[`Device`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Device)

the optional device-specific styling.

#### Returns[​](#returns-10 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`style`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#style)

***

### validation()[​](#validation "Direct link to validation()")

> **validation**(`key`): [`IValidationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder)

Starts configuring validation rules for the specified field.

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### key[​](#key-4 "Direct link to key")

`string`

the name of the validation rule.

#### Returns[​](#returns-11 "Direct link to Returns")

[`IValidationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder)

the validation builder for defining arguments.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`validation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#validation)


---

# Interface: IForm

A form.

## Properties[​](#properties "Direct link to Properties")

### defaultLanguage[​](#defaultlanguage "Direct link to defaultLanguage")

> `readonly` **defaultLanguage**: [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

Default localization language of the form.

***

### localization[​](#localization "Direct link to localization")

> `readonly` **localization**: [`ILocalizationStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ILocalizationStore)

Localization of the form.


---

# Interface: IFormData

The interface for accessing the form data.

## Properties[​](#properties "Direct link to Properties")

### clear()[​](#clear "Direct link to clear()")

> **clear**: (`clearInitialData?`) => `void`

Clears the form data.

#### Parameters[​](#parameters "Direct link to Parameters")

##### clearInitialData?[​](#clearinitialdata "Direct link to clearInitialData?")

`boolean`

if true, then also clear the initial data.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Default[​](#default "Direct link to Default")

```
true
```

***

### getValidationResult()[​](#getvalidationresult "Direct link to getValidationResult()")

> **getValidationResult**: () => `Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)>

Returns the validation results without triggering an events and changing the state of the form.

#### Returns[​](#returns-1 "Direct link to Returns")

`Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)>

the [ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) validation results.

***

### index?[​](#index "Direct link to index?")

> `optional` **index**: `number`

#### Returns[​](#returns-2 "Direct link to Returns")

the index in the array if the component is in the component array.

***

### reset()[​](#reset "Direct link to reset()")

> **reset**: (`clearInitialData?`) => `void`

Sets the form to its default value.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### clearInitialData?[​](#clearinitialdata-1 "Direct link to clearInitialData?")

`boolean`

if true, then also clear the initial data.

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Default[​](#default-1 "Direct link to Default")

```
true
```

***

### setAllErrors()[​](#setallerrors "Direct link to setAllErrors()")

> **setAllErrors**: (`message?`) => `void`

Sets the validation error message for all form data fields.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### message?[​](#message "Direct link to message?")

`string`

the validation error message.

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

***

### validate()[​](#validate "Direct link to validate()")

> **validate**: () => `Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)>

Validates the data in the form.

#### Returns[​](#returns-5 "Direct link to Returns")

`Promise`<[`ValidationMessages`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages)>

the [ValidationMessages](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages) validation results.

## Accessors[​](#accessors "Direct link to Accessors")

### data[​](#data "Direct link to data")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **data**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-6 "Direct link to Returns")

`Record`<`string`, `unknown`>

the Record with all the form data.

***

### errors[​](#errors "Direct link to errors")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **errors**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-7 "Direct link to Returns")

`Record`<`string`, `unknown`>

the Record with all validation error messages.

#### Set Signature[​](#set-signature "Direct link to Set Signature")

> **set** **errors**(`errors`): `void`

Sets the form error messages.

##### Parameters[​](#parameters-3 "Direct link to Parameters")

###### errors[​](#errors-1 "Direct link to errors")

`Record`<`string`, `unknown`>

##### Returns[​](#returns-8 "Direct link to Returns")

`void`

***

### hasErrors[​](#haserrors "Direct link to hasErrors")

#### Get Signature[​](#get-signature-2 "Direct link to Get Signature")

> **get** **hasErrors**(): `boolean`

true if the form contains errors, otherwise false.

##### Returns[​](#returns-9 "Direct link to Returns")

`boolean`

***

### isValidating[​](#isvalidating "Direct link to isValidating")

#### Get Signature[​](#get-signature-3 "Direct link to Get Signature")

> **get** **isValidating**(): `boolean`

If true, then validation is in progress.

##### Returns[​](#returns-10 "Direct link to Returns")

`boolean`

***

### parentData[​](#parentdata "Direct link to parentData")

#### Get Signature[​](#get-signature-4 "Direct link to Get Signature")

> **get** **parentData**(): `undefined` | `Record`<`string`, `unknown`>

##### Returns[​](#returns-11 "Direct link to Returns")

`undefined` | `Record`<`string`, `unknown`>

the object to read and modify parent data (available for array elements).

***

### rootData[​](#rootdata "Direct link to rootData")

#### Get Signature[​](#get-signature-5 "Direct link to Get Signature")

> **get** **rootData**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-12 "Direct link to Returns")

`Record`<`string`, `unknown`>

the object to read and modify root form data.

***

### state[​](#state "Direct link to state")

#### Get Signature[​](#get-signature-6 "Direct link to Get Signature")

> **get** **state**(): `Record`<`string`, `unknown`>

##### Returns[​](#returns-13 "Direct link to Returns")

`Record`<`string`, `unknown`>

A user-defined key-value observable storage. Utilize it to store and share any custom data.


---

# Interface: IFormJsonBuilder

Interface for building a form JSON.

## Extended by[​](#extended-by "Direct link to Extended by")

* [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

## Methods[​](#methods "Direct link to Methods")

### component()[​](#component "Direct link to component()")

> **component**(`key`, `type`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Adds a component to the form.

#### Parameters[​](#parameters "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique identifier of the component.

##### type[​](#type "Direct link to type")

`string`

the type of the component.

#### Returns[​](#returns "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for further configuration.

***

### json()[​](#json "Direct link to json()")

> **json**(): `string`

Serializes the current state of the form into a JSON string.

#### Returns[​](#returns-1 "Direct link to Returns")

`string`

JSON representation of the form.


---

# Interface: IFormViewer

The form viewer settings interface.

## Accessors[​](#accessors "Direct link to Accessors")

### formData[​](#formdata "Direct link to formData")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **formData**(): [`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

##### Returns[​](#returns "Direct link to Returns")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the [IFormData](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData) with all the form data.


---

# Interface: ILocalizationEngine

The form localization engine.

## Properties[​](#properties "Direct link to Properties")

### language[​](#language "Direct link to language")

> **language**: `` `${string}-${string}` ``

The current language.

***

### testLocalization()?[​](#testlocalization "Direct link to testLocalization()?")

> `optional` **testLocalization**: (`localization`, `localizationStringId`, `language`, `formData`) => `string` | [`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

Tests localization by formatting a message with given data.

#### Parameters[​](#parameters "Direct link to Parameters")

##### localization[​](#localization "Direct link to localization")

`string`

the localization string to test.

##### localizationStringId[​](#localizationstringid "Direct link to localizationStringId")

`string`

the ID of the localization string.

##### language[​](#language-1 "Direct link to language")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the language for the test.

##### formData[​](#formdata "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the data to use for variable substitution.

#### Returns[​](#returns "Direct link to Returns")

`string` | [`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

the array of errors or the formatted result string.

## Methods[​](#methods "Direct link to Methods")

### addMessages()[​](#addmessages "Direct link to addMessages()")

> **addMessages**(`locale`, `messages`): [`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

Adds messages to the localization engine.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### locale[​](#locale "Direct link to locale")

`string`

the locale for the messages.

##### messages[​](#messages "Direct link to messages")

`Record`<`string`, `string`>

the messages to add.

#### Returns[​](#returns-1 "Direct link to Returns")

[`LocalizationError`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LocalizationError)\[]

the array of any localization errors that occurred.

***

### getCompatibleId()[​](#getcompatibleid "Direct link to getCompatibleId()")

> **getCompatibleId**(`rawId`): `string`

Gets a compatible ID for localization engine.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### rawId[​](#rawid "Direct link to rawId")

`string`

the raw ID to make compatible.

#### Returns[​](#returns-2 "Direct link to Returns")

`string`

the compatible ID.

***

### localizeErrorMessage()[​](#localizeerrormessage "Direct link to localizeErrorMessage()")

> **localizeErrorMessage**(`form`, `formData`, `language`, `componentStore`, `ruleKey`): `undefined` | `string`

Localizes error messages for validation rules.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### form[​](#form "Direct link to form")

[`IForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm)

the form containing localization data.

##### formData[​](#formdata-1 "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data for variable substitution.

##### language[​](#language-2 "Direct link to language")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the target language for localization.

##### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component store to localize.

##### ruleKey[​](#rulekey "Direct link to ruleKey")

`string`

the validation rule key.

#### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | `string`

the localized error message or undefined.

***

### localizeProperties()[​](#localizeproperties "Direct link to localizeProperties()")

> **localizeProperties**(`form`, `formData`, `language`, `componentStore`, `type?`): `Record`<`string`, `any`>

Localizes properties for a component.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### form[​](#form-1 "Direct link to form")

[`IForm`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IForm)

the form containing localization data.

##### formData[​](#formdata-2 "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data for variable substitution.

##### language[​](#language-3 "Direct link to language")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the target language for localization.

##### componentStore[​](#componentstore-1 "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component store to localize.

##### type?[​](#type "Direct link to type?")

`string`

the type of localization (default: 'component').

#### Returns[​](#returns-4 "Direct link to Returns")

`Record`<`string`, `any`>

the object with localized property values.


---

# Interface: ILocalizationStore

Localization of the form.

## Methods[​](#methods "Direct link to Methods")

### getItems()[​](#getitems "Direct link to getItems()")

> **getItems**(`languageFullCode`): `null` | `Record`<`string`, `string`>

Returns all localization items provided by engine.

#### Parameters[​](#parameters "Direct link to Parameters")

##### languageFullCode[​](#languagefullcode "Direct link to languageFullCode")

`` `${string}-${string}` ``

the full code (en-US, en-GB etc.).

#### Returns[​](#returns "Direct link to Returns")

`null` | `Record`<`string`, `string`>

all localization items.


---

# Interface: InternalErrorProps

React component properties that display an internal form view error. **Internal use only.**

## Properties[​](#properties "Direct link to Properties")

### error[​](#error "Direct link to error")

> **error**: `any`

The internal error.


---

# Interface: IStore

The form viewer settings interface.

## Properties[​](#properties "Direct link to Properties")

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**: () => `void`

Correctly clears allocated resources, the function must be called when destroying an instance of the class.

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### form[​](#form "Direct link to form")

> **form**: [`Form`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Form)

The displayed form.

***

### reduceScreen()[​](#reducescreen "Direct link to reduceScreen()")

> **reduceScreen**: <`T`>(`callback`, `initialValue`) => `T`

Performs the callback function on each element of the component tree, accumulates the return values.

#### Type Parameters[​](#type-parameters "Direct link to Type Parameters")

##### T[​](#t "Direct link to T")

`T`

the return value type.

#### Parameters[​](#parameters "Direct link to Parameters")

##### callback[​](#callback "Direct link to callback")

(`accumulator`, `current`) => `T`

the function that calculates the value for the accumulator.

##### initialValue[​](#initialvalue "Direct link to initialValue")

`T`

the initial value for the accumulator.

#### Returns[​](#returns-1 "Direct link to Returns")

`T`

the accumulated value.

## Accessors[​](#accessors "Direct link to Accessors")

### initialDataSlice[​](#initialdataslice "Direct link to initialDataSlice")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **initialDataSlice**(): `unknown`

##### Returns[​](#returns-2 "Direct link to Returns")

`unknown`

the slice of the initial data in accordance with the Store hierarchy. **Internal use only.**

***

### showAllValidationErrors[​](#showallvalidationerrors "Direct link to showAllValidationErrors")

#### Get Signature[​](#get-signature-1 "Direct link to Get Signature")

> **get** **showAllValidationErrors**(): `undefined` | `boolean`

##### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | `boolean`

true if all validation errors are to be displayed, false otherwise.

## Methods[​](#methods "Direct link to Methods")

### localizeComponent()[​](#localizecomponent "Direct link to localizeComponent()")

> **localizeComponent**(`type`, `formData`, `componentStore`): `Record`<`string`, `unknown`>

Localizes a component store based on the given localization type. If a custom localizer is available, it will be used.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`string`

the type of localization.

##### formData[​](#formdata "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data.

##### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

#### Returns[​](#returns-4 "Direct link to Returns")

`Record`<`string`, `unknown`>

the Record with the localized properties.

***

### localizeErrorMessages()[​](#localizeerrormessages "Direct link to localizeErrorMessages()")

> **localizeErrorMessages**(`formData`, `componentStore`, `validationResults?`): `undefined` | `string`\[]

The function to localize the validation error message.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### formData[​](#formdata-1 "Direct link to formData")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data.

##### componentStore[​](#componentstore-1 "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

##### validationResults?[​](#validationresults "Direct link to validationResults?")

[`ValidationResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult)\[]

the results of the validation.

#### Returns[​](#returns-5 "Direct link to Returns")

`undefined` | `string`\[]

the result of localization or undefined.


---

# Interface: IValidationBuilder

Interface for defining validation rules for a component.

## Extends[​](#extends "Direct link to Extends")

* [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

## Methods[​](#methods "Direct link to Methods")

### args()[​](#args "Direct link to args()")

> **args**(`val`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Specifies the arguments for the validation rule.

#### Parameters[​](#parameters "Direct link to Parameters")

##### val[​](#val "Direct link to val")

`any`

the validation arguments.

#### Returns[​](#returns "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

***

### children()[​](#children "Direct link to children()")

> **children**(`childrenBuilder`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Adds child components inside this component.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### childrenBuilder[​](#childrenbuilder "Direct link to childrenBuilder")

(`builder`) => [`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

the function that builds the child components.

#### Returns[​](#returns-1 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`children`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#children)

***

### component()[​](#component "Direct link to component()")

> **component**(`key`, `type`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Adds a component to the form.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### key[​](#key "Direct link to key")

`string`

the unique identifier of the component.

##### type[​](#type "Direct link to type")

`string`

the type of the component.

#### Returns[​](#returns-2 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for further configuration.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`component`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#component)

***

### computedProp()[​](#computedprop "Direct link to computedProp()")

> **computedProp**(`key`, `value`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Sets a computed property on the component.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### key[​](#key-1 "Direct link to key")

`string`

the name of the property.

##### value[​](#value "Direct link to value")

`string`

the code of the function for calculating the property value.

#### Returns[​](#returns-3 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`computedProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#computedprop)

***

### event()[​](#event "Direct link to event()")

> **event**(`eventName`): [`IEventHandlerBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder)

Starts configuring an event handler for the given event name.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### eventName[​](#eventname "Direct link to eventName")

`string`

the name of the event (e.g., "onClick", "onChange").

#### Returns[​](#returns-4 "Direct link to Returns")

[`IEventHandlerBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder)

the event handler builder.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`event`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#event)

***

### json()[​](#json "Direct link to json()")

> **json**(): `string`

Serializes the current state of the form into a JSON string.

#### Returns[​](#returns-5 "Direct link to Returns")

`string`

JSON representation of the form.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`json`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#json)

***

### localizedProp()[​](#localizedprop "Direct link to localizedProp()")

> **localizedProp**(`key`, `language`, `value`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Sets a localized property on the component.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### key[​](#key-2 "Direct link to key")

`string`

the name of the property.

##### language[​](#language "Direct link to language")

`` `${string}-${string}` ``

the localized code, e.g. 'en-US'.

##### value[​](#value-1 "Direct link to value")

`any`

the localized value of the property.

#### Returns[​](#returns-6 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`localizedProp`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#localizedprop)

***

### prop()[​](#prop "Direct link to prop()")

> **prop**(`key`, `value`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Sets a property on the component.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### key[​](#key-3 "Direct link to key")

`string`

the name of the property.

##### value[​](#value-2 "Direct link to value")

`any`

the value of the property.

#### Returns[​](#returns-7 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`prop`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#prop)

***

### style()[​](#style "Direct link to style()")

> **style**(`value`, `device?`): [`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

Applies styles to the component, optionally per device.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

the style string (e.g., "color: red") or object with style properties.

`string` | `CSSProperties`

##### device?[​](#device "Direct link to device?")

[`Device`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Device)

the optional device-specific styling.

#### Returns[​](#returns-8 "Direct link to Returns")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder)

the component builder for method chaining.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`style`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#style)

***

### validation()[​](#validation "Direct link to validation()")

> **validation**(`key`): `IValidationBuilder`

Starts configuring validation rules for the specified field.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### key[​](#key-4 "Direct link to key")

`string`

the name of the validation rule.

#### Returns[​](#returns-9 "Direct link to Returns")

`IValidationBuilder`

the validation builder for defining arguments.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

[`IComponentBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder).[`validation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentBuilder#validation)


---

# Interface: IView

Represents all the metadata of the form viewer components.

## Properties[​](#properties "Direct link to Properties")

### all()[​](#all "Direct link to all()")

> **all**: () => [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

#### Returns[​](#returns "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

all component metadata for the form viewer.

***

### define()[​](#define "Direct link to define()")

> **define**: (`model`) => `void`

Defines the component's metadata for the form viewer.

#### Parameters[​](#parameters "Direct link to Parameters")

##### model[​](#model "Direct link to model")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

the component's metadata.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### filterModels()[​](#filtermodels "Direct link to filterModels()")

> **filterModels**: (`predicate`) => [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

Returns the array of component metadata filtered using the predicate function.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### predicate[​](#predicate "Direct link to predicate")

(`model`) => `boolean`

the filter function.

#### Returns[​](#returns-2 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

the array of component metadata filtered using the predicate function.

***

### find()[​](#find "Direct link to find()")

> **find**: (`type`) => `undefined` | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

Returns the component's metadata for the form viewer for the specified type.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### type[​](#type "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-3 "Direct link to Returns")

`undefined` | [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

the component metadata for the form viewer for the specified type or undefined.

***

### get()[​](#get "Direct link to get()")

> **get**: (`type`) => [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

Returns the component's metadata for the form viewer for the specified type.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### type[​](#type-1 "Direct link to type")

`string`

the component type.

#### Returns[​](#returns-4 "Direct link to Returns")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)

the component metadata for the form viewer for the specified type.

***

### getCssLoaders()[​](#getcssloaders "Direct link to getCssLoaders()")

> **getCssLoaders**: (`biDi`) => () => `Promise`<`void`>\[]

Retrieves the CSS loaders for a given BiDi.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### biDi[​](#bidi "Direct link to biDi")

[`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi)

the BiDi object for which to retrieve the CSS loaders.

#### Returns[​](#returns-5 "Direct link to Returns")

() => `Promise`<`void`>\[]

the array containing the CSS loaders for the specified BiDi.

***

### viewerWrappers[​](#viewerwrappers "Direct link to viewerWrappers")

> `readonly` **viewerWrappers**: [`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)\[]

Retrieves the viewer wrappers array.

#### Returns[​](#returns-6 "Direct link to Returns")

the viewer wrappers array.

***

### withCssLoader()[​](#withcssloader "Direct link to withCssLoader()")

> **withCssLoader**: (`cssLoaderType`, `loader`) => `this`

Applies the given CSS loader to the component based on the BiDi layout.

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### cssLoaderType[​](#cssloadertype "Direct link to cssLoaderType")

[`CssLoaderType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CssLoaderType)

the BiDi layout type, either 'common', 'ltr', or 'rtl'.

##### loader[​](#loader "Direct link to loader")

() => `Promise`<`void`>

the function that returns a Promise to load CSS or other required localization resources.

#### Returns[​](#returns-7 "Direct link to Returns")

`this`

the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) instance.

***

### withViewerWrapper()[​](#withviewerwrapper "Direct link to withViewerWrapper()")

> **withViewerWrapper**: (`wrapper`) => `this`

Adds a wrapper to the list of viewers for this viewer wrapper.

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### wrapper[​](#wrapper "Direct link to wrapper")

[`FormViewerWrapper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper)

the viewer wrapper to be added. The wrapper is a component that wraps the form viewer.

#### Returns[​](#returns-8 "Direct link to Returns")

`this`

the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) instance.


---

# Interface: LabeledValue

The element with the value and the label.

## Properties[​](#properties "Direct link to Properties")

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label.

***

### value[​](#value "Direct link to value")

> **value**: `string` | `number`

The value.


---

# Interface: LocalizationError

Localization error class.

## Extends[​](#extends "Direct link to Extends")

* `Error`

## Properties[​](#properties "Direct link to Properties")

### cause?[​](#cause "Direct link to cause?")

> `optional` **cause**: `unknown`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`Error.cause`

***

### message[​](#message "Direct link to message")

> **message**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`Error.message`

***

### name[​](#name "Direct link to name")

> **name**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`Error.name`

***

### stack?[​](#stack "Direct link to stack?")

> `optional` **stack**: `string`

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`Error.stack`


---

# Interface: PersistedForm

The format for saving a form designed in Form Builder.

## Properties[​](#properties "Direct link to Properties")

### actions?[​](#actions "Direct link to actions?")

> `optional` **actions**: [`ActionValues`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues)

Represents a set of action definitions.

***

### defaultLanguage[​](#defaultlanguage "Direct link to defaultLanguage")

> **defaultLanguage**: `string`

The default form language.

***

### errorProps?[​](#errorprops "Direct link to errorProps?")

> `optional` **errorProps**: `any`

Properties of the component displaying the error.

***

### errorType?[​](#errortype "Direct link to errorType?")

> `optional` **errorType**: `string`

Name of the type of component displaying the error.

***

### form[​](#form "Direct link to form")

> **form**: [`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

Settings for components that display the form.

***

### formValidator?[​](#formvalidator "Direct link to formValidator?")

> `optional` **formValidator**: `string`

The form validator.

***

### languages[​](#languages "Direct link to languages")

> **languages**: [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)\[]

Form languages.

***

### localization[​](#localization "Direct link to localization")

> **localization**: [`LocalizationValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue)

Localization of the form.

***

### modalType?[​](#modaltype "Direct link to modalType?")

> `optional` **modalType**: `string`

Name of the type of component that displays the modal.

***

### tooltipType?[​](#tooltiptype "Direct link to tooltipType?")

> `optional` **tooltipType**: `string`

Name of the type of component that displays the tooltip.

***

### version?[​](#version "Direct link to version?")

> `optional` **version**: [`version1`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/PersistedFormVersion#version1)

The version of the saved form.


---

# Interface: ScreenProps

Properties of the root component of the form. **Internal use only.**

## Properties[​](#properties "Direct link to Properties")

### children[​](#children "Direct link to children")

> **children**: `ReactNode`

The React child node.

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

If true, the children are in disabled state.

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

If true, the children are in read-only state.


---

# Interface: SuppressResizeObserverErrorsProps

Represents the props for the SuppressResizeObserverErrors component. **Internal use only.**

## Properties[​](#properties "Direct link to Properties")

### children[​](#children "Direct link to children")

> **children**: `ReactNode`

The React child node.


---

# Interface: WrapperProps

React wrapper component properties.

## Extended by[​](#extended-by "Direct link to Extended by")

* [`RsTooltipProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps)
* [`RsTooltipProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps)
* [`RsTooltipProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTooltipProps)
* [`RsTooltipProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps)

## Properties[​](#properties "Direct link to Properties")

### children[​](#children "Direct link to children")

> **children**: `ReactNode`

The React child node.

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.


---

# Type Alias: ActionData

> **ActionData** = `object`

Action Storage. Used for add a new action, store information about it.

## Properties[​](#properties "Direct link to Properties")

### \[KeySymbol]?[​](#keysymbol "Direct link to \[KeySymbol]?")

> `optional` **\[KeySymbol]**: `string`

The unique action key.

***

### args?[​](#args "Direct link to args?")

> `optional` **args**: [`Arguments`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Arguments)

The action arguments.

***

### name[​](#name "Direct link to name")

> **name**: `string`

The action name.

***

### type[​](#type "Direct link to type")

> **type**: [`ActionType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionType)

The action type.


---

# Type Alias: ActionEventHandler()

> **ActionEventHandler** = (`e`) => `void` | `Promise`<`void`>

Event handler function type.

## Parameters[​](#parameters "Direct link to Parameters")

### e[​](#e "Direct link to e")

[`ActionEventArgs`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionEventArgs)

the action arguments.

## Returns[​](#returns "Direct link to Returns")

`void` | `Promise`<`void`>


---

# Type Alias: ActionHandler()\<T>

> **ActionHandler**<`T`> = (`e`, `params`) => `void` | `Promise`<`void`>

Action function type.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the type of action parameters.

## Parameters[​](#parameters "Direct link to Parameters")

### e[​](#e "Direct link to e")

[`ActionEventArgs`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionEventArgs)

the action arguments.

### params[​](#params "Direct link to params")

`{ [k in keyof T]: any }`

the action parameters arguments.

## Returns[​](#returns "Direct link to Returns")

`void` | `Promise`<`void`>


---

# Type Alias: ActionParameters

> **ActionParameters** = `Record`<[`ParameterName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterName), [`ParameterType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterType)>

Represents a set of action parameters.


---

# Type Alias: ActionsInitializer()

> **ActionsInitializer** = (`props`, `def`) => `Record`<[`EventName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventName), [`ActionEventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler) | [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)>

The type of function that initializes an actions on a component. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)\[`"props"`]

the component's property settings.

### def[​](#def "Direct link to def")

[`DefineActionHelper`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DefineActionHelper)

the helper to create an action event handler.

## Returns[​](#returns "Direct link to Returns")

`Record`<[`EventName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventName), [`ActionEventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler) | [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)>

the Record with action event handlers.


---

# Type Alias: ActionType

> **ActionType** = `"common"` | `"code"` | `"custom"`

Action type.


---

# Type Alias: ActionValues

> **ActionValues** = `Record`<`string`, [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)>

Represents a set of action definitions.


---

# Type Alias: Annotations\<T>

> **Annotations**<`T`> = { \[key in keyof T]: BaseBuilder\<T\[key]> | undefined }

The type-safe description of the component's metadata property builders.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object`

the component property name type.


---

# Type Alias: AnnotationType

> **AnnotationType** = `"Property"` | `"Container"` | `"Event"` | `"Module"` | `"Style"`

Type of component property description in the form builder.


---

# Type Alias: Arguments

> **Arguments** = `Record`<[`ParameterName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterName), [`ArgumentValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ArgumentValue)>

It will be transformed in arguments before passing in action.


---

# Type Alias: ArgumentValue

> **ArgumentValue** = [`PrimitiveArgumentValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PrimitiveArgumentValue) | [`FunctionArgumentValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FunctionArgumentValue)

The type of the argument value of the function.


---

# Type Alias: AriaAttributesIds

> **AriaAttributesIds** = `Record`\<keyof `Pick`<`AriaAttributes`, `"aria-labelledby"` | `"aria-errormessage"`>, `string`>

The record with 'aria' attributes.


---

# Type Alias: AriaAttributesOptions

> **AriaAttributesOptions** = `object`

Represents the options for ARIA attributes configurations.

## Properties[​](#properties "Direct link to Properties")

### labeled[​](#labeled "Direct link to labeled")

> **labeled**: `boolean`

Indicates whether an item, element, or entity is marked or tagged with a label.


---

# Type Alias: BoundValueSchema

> **BoundValueSchema** = `object`

Value validation rules.

## Properties[​](#properties "Direct link to Properties")

### autoValidate?[​](#autovalidate "Direct link to autoValidate?")

> `optional` **autoValidate**: `boolean`

Flag, if true then automatic validation of the value works, false otherwise.

***

### validations?[​](#validations "Direct link to validations?")

> `optional` **validations**: [`ValidationRuleSettings`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSettings)\[]

The array of validation rule settings.


---

# Type Alias: BuilderMode

> **BuilderMode** = `"builder"` | `"viewer"`

Form builder mode. Builder or viewer.


---

# Type Alias: BuilderSetup

> **BuilderSetup** = `Partial`<[`PreAnnotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation) & [`BuilderOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions)>

The type representing custom options for the component's property metadata builder.


---

# Type Alias: BuilderTheme

> **BuilderTheme** = `"dark"` | `"light"`

Builder theme mode - either dark or light.


---

# Type Alias: CellInfo

> **CellInfo** = `object`

The information about a cell.

## Properties[​](#properties "Direct link to Properties")

### dataKey?[​](#datakey "Direct link to dataKey?")

> `optional` **dataKey**: [`DataKeyType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataKeyType)

The data key.

***

### rowData?[​](#rowdata "Direct link to rowData?")

> `optional` **rowData**: `Record`<[`DataKeyType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DataKeyType), `unknown`>

The row data.

***

### rowIndex?[​](#rowindex "Direct link to rowIndex?")

> `optional` **rowIndex**: `number`

The row index.


---

# Type Alias: ComponentDescription

> **ComponentDescription** = [`I18nItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/I18nItem) & `object`

The description of a component.

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### props?[​](#props "Direct link to props?")

> `optional` **props**: `Record`<`string`, [`I18nItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/I18nItem)>

The properties of the component.


---

# Type Alias: ComponentDeviceStyle

> **ComponentDeviceStyle** = `object`

Styles for a device.

## Properties[​](#properties "Direct link to Properties")

### string?[​](#string "Direct link to string?")

> `optional` **string**: `string`

The CSS string.


---

# Type Alias: ComponentFeature

> **ComponentFeature** = `object`

A component feature defining a component's characteristic.

## Properties[​](#properties "Direct link to Properties")

### allowMultiple[​](#allowmultiple "Direct link to allowMultiple")

> **allowMultiple**: `boolean`

Flag, if true the feature can contain multiple values, false otherwise.

***

### name[​](#name "Direct link to name")

> **name**: `string`

The component feature name.


---

# Type Alias: ComponentFeatures

> **ComponentFeatures** = `Record`<`string`, `unknown`>

The component features.


---

# Type Alias: ComponentKey

> **ComponentKey** = `string`

The component key.


---

# Type Alias: ComponentKind

> **ComponentKind** = `"container"` | `"component"` | `"template"` | `"repeater"`

The component kind type.


---

# Type Alias: ComponentLibraryDescription

> **ComponentLibraryDescription** = `object`

A component library description.

## Properties[​](#properties "Direct link to Properties")

### categories?[​](#categories "Direct link to categories?")

> `optional` **categories**: `Record`<`string`, [`I18nItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/I18nItem)>

A record mapping category names to their descriptions.

***

### commonProperties?[​](#commonproperties "Direct link to commonProperties?")

> `optional` **commonProperties**: `Record`<`string`, [`I18nItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/I18nItem)>

A record mapping common component properties to their descriptions.

***

### components?[​](#components "Direct link to components?")

> `optional` **components**: `Record`<`string`, [`ComponentDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDescription)>

A record mapping component names to their descriptions.


---

# Type Alias: ComponentLocalizer()

> **ComponentLocalizer** = (`componentStore`, `language`) => `Record`<`string`, `any`>

The function to localize the properties of a component.

## Parameters[​](#parameters "Direct link to Parameters")

### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

the component settings.

### language[​](#language "Direct link to language")

[`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

the language selected in the form viewer.

## Returns[​](#returns "Direct link to Returns")

`Record`<`string`, `any`>

the Record with the localized properties of a component.


---

# Type Alias: ComponentPropertiesContext

> **ComponentPropertiesContext** = `object`

The component properties context type.

## Properties[​](#properties "Direct link to Properties")

### cellInfo?[​](#cellinfo "Direct link to cellInfo?")

> `readonly` `optional` **cellInfo**: [`CellInfo`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CellInfo)

The information about the cell.

***

### eventHandlers?[​](#eventhandlers "Direct link to eventHandlers?")

> `readonly` `optional` **eventHandlers**: `Record`<[`EventName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventName), [`ActionEventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler)>

The event handlers.

***

### valueProperty?[​](#valueproperty "Direct link to valueProperty?")

> `readonly` `optional` **valueProperty**: [`ReactProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ReactProperty)

The value property.


---

# Type Alias: ComponentPropertyBindType

> **ComponentPropertyBindType** = `"single"` | `"array"`

The component property binding type.


---

# Type Alias: ComponentPropertyComputeType

> **ComponentPropertyComputeType** = `"function"` | `"localization"`

The component property value type.


---

# Type Alias: ComponentPropertyName

> **ComponentPropertyName** = `string`

The component property name.


---

# Type Alias: ComponentPropsLocalization

> **ComponentPropsLocalization** = `Record`<[`ComponentPropertyName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyName), `string`>

A record containing localizations for the component properties.


---

# Type Alias: ComponentRole

> **ComponentRole** = `"label"` | `"tooltip"` | `"error-message"` | `"modal"` | `string`

The role of a component, such as a label, tooltip, etc.


---

# Type Alias: ComponentsLocalization

> **ComponentsLocalization** = `Record`<[`ComponentKey`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKey), [`TypedLocalization`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/TypedLocalization)>

A record containing localizations grouped by component key.


---

# Type Alias: ComponentStateFactory()

> **ComponentStateFactory** = (`data`, `store`, `context?`) => [`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState)

The component state factory that calculates the properties of the form viewer component.

## Parameters[​](#parameters "Direct link to Parameters")

### data[​](#data "Direct link to data")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the data needed to display the component.

### store[​](#store "Direct link to store")

[`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)

the form viewer settings.

### context?[​](#context "Direct link to context?")

[`ComponentPropertiesContext`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertiesContext)

the context for working with component properties.

## Returns[​](#returns "Direct link to Returns")

[`IComponentState`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState)

the component property calculator.


---

# Type Alias: ComponentStoreLocalizer()

> **ComponentStoreLocalizer** = (`componentStore`) => `Record`<`string`, `any`>

Represents a function that localizes components based on the supplied component store.

## Parameters[​](#parameters "Direct link to Parameters")

### componentStore[​](#componentstore "Direct link to componentStore")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

## Returns[​](#returns "Direct link to Returns")

`Record`<`string`, `any`>


---

# Type Alias: ComponentStyle

> **ComponentStyle** = `object`

The type for the style property of a React component.

## Properties[​](#properties "Direct link to Properties")

### any?[​](#any "Direct link to any?")

> `optional` **any**: [`ComponentDeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDeviceStyle)

Styles for an arbitrary device.

***

### desktop?[​](#desktop "Direct link to desktop?")

> `optional` **desktop**: [`ComponentDeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDeviceStyle)

Styles for desktop devices.

***

### mobile?[​](#mobile "Direct link to mobile?")

> `optional` **mobile**: [`ComponentDeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDeviceStyle)

Styles for mobile devices.

***

### tablet?[​](#tablet "Direct link to tablet?")

> `optional` **tablet**: [`ComponentDeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDeviceStyle)

Styles for tablet devices.


---

# Type Alias: ComputeChildren()

> **ComputeChildren** = (`componentData`, `componentProps`) => `Record`<`string`, `any`>

Function that calculates all child properties of a component. **Internal use only.**

## Parameters[​](#parameters "Direct link to Parameters")

### componentData[​](#componentdata "Direct link to componentData")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the data required to display a component.

### componentProps[​](#componentprops "Direct link to componentProps")

`Record`<`string`, `any`>

the calculated properties of the component.

## Returns[​](#returns "Direct link to Returns")

`Record`<`string`, `any`>

the Record with calculated child properties.


---

# Type Alias: Css

> **Css** = `object`

The type for the CSS property of a React component.

## Properties[​](#properties "Direct link to Properties")

### any?[​](#any "Direct link to any?")

> `optional` **any**: [`DeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DeviceStyle)

CSS styles for arbitrary device.

***

### desktop?[​](#desktop "Direct link to desktop?")

> `optional` **desktop**: [`DeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DeviceStyle)

CSS styles for desktop devices.

***

### mobile?[​](#mobile "Direct link to mobile?")

> `optional` **mobile**: [`DeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DeviceStyle)

CSS styles for mobile devices.

***

### tablet?[​](#tablet "Direct link to tablet?")

> `optional` **tablet**: [`DeviceStyle`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/DeviceStyle)

CSS styles for tablet devices.


---

# Type Alias: CssLoaderType

> **CssLoaderType** = [`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi) | `"common"`

Represents the type of CSS loader. Can be either BiDi or common for both BiDi.


---

# Type Alias: CssPart

> **CssPart** = `"css"` | `"wrapperCss"`

The part of the CSS properties of a component.


---

# Type Alias: CustomActions

> **CustomActions** = `Record`<`string`, [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition) | [`ActionEventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler)>

Custom actions for the form viewer.


---

# Type Alias: CustomValidationRules

> **CustomValidationRules** = `Record`<`string`, [`CustomValidationRuleSettings`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRuleSettings)>

A set of metadata of custom validation rules, grouped by rule name.


---

# Type Alias: CustomValidationRuleSettings

> **CustomValidationRuleSettings** = `object`

Custom validation rule settings.

## Properties[​](#properties "Direct link to Properties")

### params?[​](#params "Direct link to params?")

> `optional` **params**: [`ValidationRuleParameter`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleParameter)\[]

Metadata of validation rule parameters.

***

### validate[​](#validate "Direct link to validate")

> **validate**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The function that validates the value.


---

# Type Alias: DataBindingType

> **DataBindingType** = `"oneWay"` | `"twoWay"` | `"none"`

The type of component data binding.


---

# Type Alias: DataKeyType

> **DataKeyType** = `string` | `number` | `symbol`

The data key type.


---

# Type Alias: DefineActionHelper()

> **DefineActionHelper** = <`T`>(`name`, `func`, `params?`, `description?`) => [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)

The defineAction helper type. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the type of action parameter.

## Parameters[​](#parameters "Direct link to Parameters")

### name[​](#name "Direct link to name")

`string`

the action name.

### func[​](#func "Direct link to func")

[`ActionHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionHandler)<`T`>

the action handler.

### params?[​](#params "Direct link to params?")

[`ParameterDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterDefinition)<`T`>\[]

the definition of action parameters.

### description?[​](#description "Direct link to description?")

`string`

the action description.

## Returns[​](#returns "Direct link to Returns")

[`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)

the definition of an action.


---

# Type Alias: DefinerData\<T>

> **DefinerData**<`T`> = `object`

Definer class data.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object`

React component property type.

## Properties[​](#properties "Direct link to Properties")

### actionsInitializer?[​](#actionsinitializer "Direct link to actionsInitializer?")

> `readonly` `optional` **actionsInitializer**: [`ActionsInitializer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionsInitializer)

The function that initializes an actions on a component (for internal use only).

***

### category?[​](#category "Direct link to category?")

> `optional` **category**: `string`

The component category.

***

### component[​](#component "Direct link to component")

> `readonly` **component**: `ComponentType`<`T`>

The React component.

***

### cssObject?[​](#cssobject "Direct link to cssObject?")

> `optional` **cssObject**: [`Annotations`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)<`CSSObject`>

The component CSS metadata.

***

### ~~customPreview?~~[​](#custompreview "Direct link to custompreview")

> `optional` **customPreview**: `ReactNode`

#### Deprecated[​](#deprecated "Direct link to Deprecated")

The custom component to display in the component list (unused).

***

### eventListeners?[​](#eventlisteners "Direct link to eventListeners?")

> `optional` **eventListeners**: [`ComponentMetadataEventListeners`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners)

The component metadata event listeners.

***

### features?[​](#features "Direct link to features?")

> `optional` **features**: [`ComponentFeatures`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeatures)

The set of component features.

***

### icon?[​](#icon "Direct link to icon?")

> `optional` **icon**: `ComponentType` | `string`

The component icon or the icon name.

***

### initialJson?[​](#initialjson "Direct link to initialJson?")

> `optional` **initialJson**: `string`

The JSON source for the component (instance of [ComponentStore](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore) class serialised to JSON).

***

### insertRestriction?[​](#insertrestriction "Direct link to insertRestriction?")

> `optional` **insertRestriction**: [`InsertRestrictionFn`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn)

The function that restricts the insertion of a component into another component.

***

### kind?[​](#kind "Direct link to kind?")

> `optional` **kind**: [`ComponentKind`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKind)

The component kind.

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

The component name.

***

### properties?[​](#properties-1 "Direct link to properties?")

> `optional` **properties**: [`Annotations`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)<`T`>

The property metadata.

***

### wrapperCssObject?[​](#wrappercssobject "Direct link to wrapperCssObject?")

> `optional` **wrapperCssObject**: [`Annotations`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations)<`CSSObject`>

The wrapper CSS metadata.


---

# Type Alias: Device

> **Device** = `"any"` | `"desktop"` | `"mobile"` | `"tablet"`

Represents the target device for applying styles.


---

# Type Alias: DeviceStyle

> **DeviceStyle** = `object`

CSS styles for a device.

## Properties[​](#properties "Direct link to Properties")

### object?[​](#object "Direct link to object?")

> `optional` **object**: `any`

CSS styles defined in the general style settings.

***

### string?[​](#string "Direct link to string?")

> `optional` **string**: `string`

CSS styles defined in the style code editor.


---

# Type Alias: EditorType

> **EditorType** = `string`

A type that denotes the name of the property editor.


---

# Type Alias: ErrorMap

> **ErrorMap** = `object`

The result of validating a component property in the form builder.

## Properties[​](#properties "Direct link to Properties")

### code?[​](#code "Direct link to code?")

> `optional` **code**: `string`

The validation code.

***

### message?[​](#message "Direct link to message?")

> `optional` **message**: `string`

The validation message.


---

# Type Alias: ErrorMessageLocalizer()

> **ErrorMessageLocalizer** = (`value`) => `string`\[] | `undefined`

A function that localizes validation error messages.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

the results of the validation.

[`ValidationResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult)\[] | `undefined`

## Returns[​](#returns "Direct link to Returns")

`string`\[] | `undefined`

the localization result or undefined.


---

# Type Alias: EventHandler()

> **EventHandler** = (...`args`) => `unknown`

The event handler function.

## Parameters[​](#parameters "Direct link to Parameters")

### args[​](#args "Direct link to args")

...`unknown`\[]

## Returns[​](#returns "Direct link to Returns")

`unknown`


---

# Type Alias: EventName

> **EventName** = `string`

The type for the event name.


---

# Type Alias: FieldType

> **FieldType** = `"simple"` | `"template"` | `"repeater"`

The field type.


---

# Type Alias: FirstParameter\<T>

> **FirstParameter**<`T`> = `Parameters`<`T`>\[`0`]

The generic type that returns the first parameter of the generic type T. **Internal use only.**

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* (...`args`) => `any`


---

# Type Alias: FormBuilderComponentIconName

> **FormBuilderComponentIconName** = *typeof* [`iconsList`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/iconsList)\[`number`]

The name of the icon for a form builder component.


---

# Type Alias: FormOptions

> **FormOptions** = `object`

Options for configuring the form behavior.

## Properties[​](#properties "Direct link to Properties")

### defaultLanguage?[​](#defaultlanguage "Direct link to defaultLanguage?")

> `optional` **defaultLanguage**: `string`

The default form language.

***

### errorType?[​](#errortype "Direct link to errorType?")

> `optional` **errorType**: `string`

The type of component that displays validation errors.


---

# Type Alias: FormValidator()

> **FormValidator** = (`data`) => `Promise`<`Record`<`string`, `string`> | `undefined`>

Represents a function that validate the form data.

## Parameters[​](#parameters "Direct link to Parameters")

### data[​](#data "Direct link to data")

`Record`<`string`, `unknown`>

the form data.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`Record`<`string`, `string`> | `undefined`>

the Record with form field errors.


---

# Type Alias: FormValidators

> **FormValidators** = [`FormValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidator)\[]

Represents an array of functions that validate the form data.


---

# Type Alias: FormViewerValidationRules

> **FormViewerValidationRules** = `object`

Validation rules for FormViewer.

## Properties[​](#properties "Direct link to Properties")

### custom?[​](#custom "Direct link to custom?")

> `optional` **custom**: [`CustomValidationRules`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRules)

The set of custom validators.

***

### internal[​](#internal "Direct link to internal")

> **internal**: [`ValidationRuleSet`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSet)

The set of internal validators.


---

# Type Alias: FormViewerWrapper

> **FormViewerWrapper** = `ComponentType`<[`FormViewerWrapperComponentProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerWrapperComponentProps)>

Represents a form viewer Wrapper component.


---

# Type Alias: Func()

> **Func** = (...`arg`) => `void` | `Promise`<`void`>

The type of arbitrary function that returns void or Promise\<void>.

## Parameters[​](#parameters "Direct link to Parameters")

### arg[​](#arg "Direct link to arg")

...`any`\[]

## Returns[​](#returns "Direct link to Returns")

`void` | `Promise`<`void`>


---

# Type Alias: FunctionArgumentValue

> **FunctionArgumentValue** = `object`

Function argument value type.

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body "Direct link to body?")

> `optional` **body**: `string`

The source code of the function for use in design mode.

***

### type[​](#type "Direct link to type")

> **type**: `"fn"`

Argument type for function type.


---

# Type Alias: GetInitialDataFn()

> **GetInitialDataFn** = () => `unknown`

Returns the initial data for the field.

## Returns[​](#returns "Direct link to Returns")

`unknown`


---

# Type Alias: HtmlAttribute

> **HtmlAttribute** = `Record`<`string`, `string`>

The arbitrary HTML attributes for the component.


---

# Type Alias: I18nItem

> **I18nItem** = `object`

The i18n item.

## Properties[​](#properties "Direct link to Properties")

### description?[​](#description "Direct link to description?")

> `optional` **description**: `string`

The description of the item.

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

The name of the item.


---

# Type Alias: iconsList

> **iconsList** = readonly \[`"Breadcrumb"`, `"Button"`, `"Card"`, `"Checkbox"`, `"CollectionEditor"`, `"Container"`, `"Content"`, `"CustomBlock"`, `"CustomControl"`, `"DatePicker"`, `"Default"`, `"Dropdown"`, `"Dropzone"`, `"ErrorMessage"`, `"Grid"`, `"GridLayout"`, `"GridView"`, `"Image"`, `"Input"`, `"Label"`, `"Link"`, `"Footer"`, `"Header"`, `"Sidebar"`, `"Menu"`, `"Message"`, `"NumberFormat"`, `"PatternFormat"`, `"ProgressCircle"`, `"ProgressLine"`, `"RadioGroup"`, `"Repeater"`, `"RichTextEditor"`, `"Search"`, `"Signature"`, `"Sparks"`, `"StaticContent"`, `"Tab"`, `"TextArea"`, `"TimePicker"`, `"Toggle"`, `"Tooltip"`, `"TreePicker"`, `"Uploader"`]


---

# Type Alias: IDisposable

> **IDisposable** = `object`

Type of disposable object.

## Properties[​](#properties "Direct link to Properties")

### dispose()[​](#dispose "Direct link to dispose()")

> **dispose**: () => `void`

Performs the tasks necessary to release resources correctly.

#### Returns[​](#returns "Direct link to Returns")

`void`


---

# Type Alias: InsertRestrictionFn()

> **InsertRestrictionFn** = (`self`, `target`, `slot?`) => `boolean`

The function that restricts the insertion of a component into another component.

## Parameters[​](#parameters "Direct link to Parameters")

### self[​](#self "Direct link to self")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

### target[​](#target "Direct link to target")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

### slot?[​](#slot "Direct link to slot?")

`string`

## Returns[​](#returns "Direct link to Returns")

`boolean`


---

# Type Alias: LanguageFullCode

> **LanguageFullCode** = `` `${string}-${string}` ``

The full language code, e.g. 'en-US'.


---

# Type Alias: LocalizationType

> **LocalizationType** = `"component"` | `"tooltip"` | `"modal"` | `string`

Represents the type of localization. The localization can be for a component, tooltip or for validator.


---

# Type Alias: LocalizationValue

> **LocalizationValue** = `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentsLocalization`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentsLocalization)>

The format in which localization is stored.

## Example[​](#example "Direct link to Example")

```
{
 *  "en-US": {
 *    "componentKey": {
 *      "property": "This {$value} is localized!"
 *    }
 *  }
 * }
```


---

# Type Alias: MessagesMap

> **MessagesMap** = `Record`<`string`, `string`\[] | `Record`<`string`, `string`\[] | `any`>>

The validation result messages map.


---

# Type Alias: ModalComponentStore

> **ModalComponentStore** = `object`

Modal settings for serialization in JSON.

## Properties[​](#properties "Direct link to Properties")

### events?[​](#events "Direct link to events?")

> `optional` **events**: `Record`<[`EventName`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventName), [`ActionData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData)\[]>

The set of event handlers.

***

### props[​](#props "Direct link to props")

> **props**: `Record`<`string`, [`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)>

The component properties.


---

# Type Alias: NamedActionDefinition

> **NamedActionDefinition** = `object`

Represents a named action definition.

## Properties[​](#properties "Direct link to Properties")

### actionDefinition[​](#actiondefinition "Direct link to actionDefinition")

> **actionDefinition**: [`ActionDefinition`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition)

The definition of an action.

***

### name[​](#name "Direct link to name")

> **name**: `string`

The name of action definition.


---

# Type Alias: NodeEditorType

> **NodeEditorType** = `"node"` | `"string"`

The editor type for the "ReactNode" type property.


---

# Type Alias: ParameterDefinition\<T>

> **ParameterDefinition**<`T`> = \[[`PropertyKey`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/PropertyKey)<`T`>, [`ParameterType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterType)]

The type to describe the action parameter.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the type of action parameter.


---

# Type Alias: ParameterName

> **ParameterName** = `string`

The type for the parameter name.


---

# Type Alias: ParameterType

> **ParameterType** = `"string"` | `"number"` | `"boolean"` | `"function"`

Parameter type.


---

# Type Alias: PreAnnotation

> **PreAnnotation** = `Partial`<`Omit`<[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation), `"key"`>> & `Pick`<[`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation), `"editor"`>

Type for component property metadata without the 'key' property, but with the 'editor' property.


---

# Type Alias: PrimitiveArgumentValue

> **PrimitiveArgumentValue** = `string` | `number` | `boolean`

Primitive argument value type.


---

# Type Alias: PropertyBlockType

> **PropertyBlockType** = `"component"` | `"tooltip"` | `"modal"` | `string`

Represents the type of property block.


---

# Type Alias: PropertyKey\<T>

> **PropertyKey**<`T`> = keyof `T` & `string`

Component property key type.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the type of action parameter


---

# Type Alias: ReactProperty

> **ReactProperty** = `object`

The React component property.

## Properties[​](#properties "Direct link to Properties")

### propertyName[​](#propertyname "Direct link to propertyName")

> `readonly` **propertyName**: `string`

The value property name.

***

### propertyValue[​](#propertyvalue "Direct link to propertyValue")

> `readonly` **propertyValue**: `unknown`

#### Returns[​](#returns "Direct link to Returns")

the property value.


---

# Type Alias: Rel

> **Rel** = `"stylesheet"` | `string`

Represents a relationship attribute value used in HTML.


---

# Type Alias: ResolvedValidator()

> **ResolvedValidator** = (`value`, `store`, `getFormData?`) => `Promise`<[`ValidationResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult)\[] | `undefined`>

The function that validates a value and returns the validation result.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`any`

the validated value.

### store[​](#store "Direct link to store")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)

the form viewer settings.

### getFormData?[​](#getformdata "Direct link to getFormData?")

() => [`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the function that returns a form data.

## Returns[​](#returns "Direct link to Returns")

`Promise`<[`ValidationResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult)\[] | `undefined`>

the Promise with the results of the validation.


---

# Type Alias: RuleValidator()\<T>

> **RuleValidator**<`T`> = (`value`, `store`, `args?`, `formData?`) => [`RuleValidatorResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult) | `Promise`<[`RuleValidatorResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult)>

The function that checks the value and returns the result of the rule validation, see [RuleValidatorResult](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult).

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` = `any`

the value type.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`T`

the value.

### store[​](#store "Direct link to store")

[`IStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IStore)

the form viewer settings

### args?[​](#args "Direct link to args?")

`Record`<`string`, `unknown`>

the rule arguments.

### formData?[​](#formdata "Direct link to formData?")

[`IFormData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormData)

the form data.

## Returns[​](#returns "Direct link to Returns")

[`RuleValidatorResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult) | `Promise`<[`RuleValidatorResult`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult)>


---

# Type Alias: RuleValidatorResult

> **RuleValidatorResult** = `string` | `boolean`

The result of validation of a single rule, true means validation was successful, false means validation failed, string means error message.


---

# Type Alias: SchemaResolver()\<T>

> **SchemaResolver**<`T`> = (`value`) => [`ResolvedValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ResolvedValidator)

The validation function factory.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the validation function factory arguments.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`T`

the validated value.

## Returns[​](#returns "Direct link to Returns")

[`ResolvedValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ResolvedValidator)

the function that validates a value.


---

# Type Alias: SchemaType

> **SchemaType** = keyof [`SchemaTypeMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap)

The value type name.


---

# Type Alias: SchemaTypeMap

> **SchemaTypeMap** = `object`

Describes the mapping of a value type name to a type.

## Properties[​](#properties "Direct link to Properties")

### array[​](#array "Direct link to array")

> **array**: `any`\[]

The array.

***

### boolean[​](#boolean "Direct link to boolean")

> **boolean**: `boolean`

The boolean.

***

### date[​](#date "Direct link to date")

> **date**: `Date`

The date.

***

### enum[​](#enum "Direct link to enum")

> **enum**: `any`

The enumeration.

***

### number[​](#number "Direct link to number")

> **number**: `number`

The number.

***

### object[​](#object "Direct link to object")

> **object**: `object`

The object.

***

### string[​](#string "Direct link to string")

> **string**: `string`

The string.

***

### time[​](#time "Direct link to time")

> **time**: `string`

The time.


---

# Type Alias: SetInitialDataFn()

> **SetInitialDataFn** = (`key`, `value`) => `void`

Sets the initial data.

## Parameters[​](#parameters "Direct link to Parameters")

### key[​](#key "Direct link to key")

`string` | `number`

### value[​](#value "Direct link to value")

`unknown`

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Type Alias: Setter()\<T>

> **Setter**<`T`> = (`value`) => `void`

Value setting function type.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` = `any`

the value type.

## Parameters[​](#parameters "Direct link to Parameters")

### value[​](#value "Direct link to value")

`T`

the value.

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Type Alias: SyncEventHandler()\<TSender, TEventArgs>

> **SyncEventHandler**<`TSender`, `TEventArgs`> = (`source`, `eventArgs`) => `void`

Represents a synchronous event handler.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### TSender[​](#tsender "Direct link to TSender")

`TSender`

the type of the event source.

### TEventArgs[​](#teventargs "Direct link to TEventArgs")

`TEventArgs`

the type of the event arguments.

## Parameters[​](#parameters "Direct link to Parameters")

### source[​](#source "Direct link to source")

`TSender`

### eventArgs[​](#eventargs "Direct link to eventArgs")

`TEventArgs`

## Returns[​](#returns "Direct link to Returns")

`void`


---

# Type Alias: TemplateProps

> **TemplateProps** = `Omit`<[`EmbeddedFormProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/EmbeddedFormProps), `"formName"`>

The template component properties.


---

# Type Alias: TypedLocalization

> **TypedLocalization** = `Partial`<`Record`<[`LocalizationType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationType), [`ComponentPropsLocalization`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropsLocalization)>>

A record containing localizations grouped by localization type.


---

# Type Alias: ValidationMessages

> **ValidationMessages** = `string`\[] | [`MessagesMap`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/MessagesMap) | `undefined`

The validation result messages.


---

# Type Alias: ValidationResult

> **ValidationResult** = `object`

The result of the validation.

## Properties[​](#properties "Direct link to Properties")

### message?[​](#message "Direct link to message?")

> `optional` **message**: `string`

The validation error message text.

***

### settings[​](#settings "Direct link to settings")

> **settings**: [`ValidationRuleSettings`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSettings)

The validation rule settings.


---

# Type Alias: ValidationRule

> **ValidationRule** = `object`

Validation rule metadata required to create a validation function.

## Properties[​](#properties "Direct link to Properties")

### params?[​](#params "Direct link to params?")

> `optional` **params**: [`ValidationRuleParameter`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleParameter)\[]

Metadata of validation rule parameters.

***

### validatorFactory[​](#validatorfactory "Direct link to validatorFactory")

> **validatorFactory**: [`ValidatorFactory`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorFactory)<`any`>

The validation function factory.


---

# Type Alias: ValidationRuleParameter

> **ValidationRuleParameter** = `object`

Describes the settings of the validation rule parameter.

## Properties[​](#properties "Direct link to Properties")

### default?[​](#default "Direct link to default?")

> `optional` **default**: `unknown`

The default value.

***

### editorType?[​](#editortype "Direct link to editorType?")

> `optional` **editorType**: `string`

The editor type of the setting value.

***

### key[​](#key "Direct link to key")

> **key**: `string`

The unique setting key of the parameter.

***

### required[​](#required "Direct link to required")

> **required**: `boolean`

Flag whether the setting value must be filled in.

***

### type[​](#type "Direct link to type")

> **type**: [`SchemaType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaType)

The type of value.


---

# Type Alias: ValidationRuleSet

> **ValidationRuleSet** = `Record`<`string`, [`ValidationRule`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRule)>

Describes a set of validation rules.


---

# Type Alias: ValidationRuleSettings

> **ValidationRuleSettings** = `object`

The validation rule settings.

## Properties[​](#properties "Direct link to Properties")

### args?[​](#args "Direct link to args?")

> `optional` **args**: `Record`<`string`, `any`>

Arguments of the validation rule.

***

### key[​](#key "Direct link to key")

> **key**: `string`

The unique key of the validation rule. The key is unique within the value type.

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: [`ValidatorType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorType)

The type of validator.

***

### validateWhen?[​](#validatewhen "Direct link to validateWhen?")

> `optional` **validateWhen**: [`ComponentProperty`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty)

The property that determines when validation needs to be performed.


---

# Type Alias: ValidatorFactory()\<Params>

> **ValidatorFactory**<`Params`> = (`args`) => [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

The validation function factory.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### Params[​](#params "Direct link to Params")

`Params`

the factory arguments type.

## Parameters[​](#parameters "Direct link to Parameters")

### args[​](#args "Direct link to args")

`Params`

the factory arguments.

## Returns[​](#returns "Direct link to Returns")

[`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)

the function that checks the value and returns the result of the rule validation


---

# Type Alias: Validators

> **Validators** = `Partial`<`Record`<[`SchemaType`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaType), [`CustomValidationRules`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRules)>>

The set of metadata of custom validation rules, grouped by the type of value being validated.


---

# Type Alias: ValidatorType

> **ValidatorType** = `"internal"` | `"custom"`

The type of validator.


---

# Type Alias: ViewMode

> **ViewMode** = `"desktop"` | `"mobile"` | `"tablet"`

Display resolution type.


---

# Variable: ActionEventArgsDeclaration

> `const` **ActionEventArgsDeclaration**: "\n/\*\*\n \* Arguments passed to the event handler.\n \*/\ndeclare class ActionEventArgs {\n\n /\*\*\n \* The event type.\n \*/\n readonly type: string\n\n /\*\*\n \* The component that triggered the event.\n \*/\n readonly sender: ComponentData\n \n /\*\*\n \* The component properties that were used to render the sender component.\n \*/\n readonly renderedProps: Record\<string, any>\n\n /\*\*\n \* The index of the component in the array, if the component is in the array.\n \*/\n readonly index?: number\n\n /\*\*\n \* @returns user-defined properties for the React component that override other properties of the component.\n \*/\n get userDefinedProps(): Record\<string, any>\n\n /\*\*\n \* Sets current props of component.\n \*/\n readonly setUserDefinedProps: (props: Record\<string, any>) => void\n\n /\*\*\n \* The form viewer settings.\n \*/\n readonly store: Store\n\n /\*\*\n \* The event arguments.\n \*/\n readonly args: any\[]\n\n /\*\*\n \* @returns the event handled by the event handler.\n \*/\n get event(): SyntheticEvent | null\n\n /\*\*\n \* @returns the first element of the event argument array, which is treated as a value.\n \*/\n get value(): any\n \n /\*\*\n \* @returns the object for reading and changing form data.\n \*/\n get data(): Record\<string, unknown>\n \n /\*\*\n \* @returns the object to read and modify parent data (available for array elements).\n \*/\n get parentData(): Record\<string, unknown> | undefined\n\n /\*\*\n \* @returns the object to read and modify root form data.\n \*/\n get rootData(): Record\<string, unknown>\n \n /\*\*\n \* The information about the current cell.\n \*/\n readonly cellInfo?: CellInfo\n}\n"

Description of the event argument type for the code editor.


---

# Variable: array

> `const` **array**: [`ArrayBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder)<`undefined` | `unknown`\[]>

The annotation builder for a component property with type 'Array'.


---

# Variable: AsyncFunction

> `const` **AsyncFunction**: `Function`

Asynchronous function constructor.


---

# Variable: boolean

> `const` **boolean**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `boolean`>

The annotation builder for a component property with type 'boolean'.


---

# Variable: BuilderModeProvider

> **BuilderModeProvider**: `Provider`<[`BuilderMode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderMode)>

The BuilderMode context provider.


---

# Variable: BuilderThemeProvider

> **BuilderThemeProvider**: `Provider`<[`BuilderTheme`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderTheme)>

Context provider for the [useBuilderTheme](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/variables/useBuilderTheme) hook.


---

# Variable: CellInfoContextProvider

> **CellInfoContextProvider**: `Provider`<[`CellInfo`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/CellInfo)>


---

# Variable: cfComponentIsPreset

> `const` **cfComponentIsPreset**: `"component-is-preset"` = `'component-is-preset'`

A component feature that indicates that the component is a preset.


---

# Variable: cfDisableActionEditors

> `const` **cfDisableActionEditors**: `"disable-action-editors"` = `'disable-action-editors'`

Enabling this component feature will hide the 'Actions' editors.


---

# Variable: cfDisableAdditionalProperties

> `const` **cfDisableAdditionalProperties**: `"disable-additional-properties"` = `'disable-additional-properties'`

Enabling this component feature will hide the component's additional properties' editor.


---

# Variable: cfDisableComponentRemove

> `const` **cfDisableComponentRemove**: `"disable-component-remove"` = `'disable-component-remove'`

Enabling this component feature will prevent this component from being removed.


---

# Variable: cfDisableMainComponentProperties

> `const` **cfDisableMainComponentProperties**: `"disable-main-component-properties"` = `'disable-main-component-properties'`

Enabling this component feature will hide the main component's property editors, except for the key property and additional properties.


---

# Variable: cfDisableStyleProperties

> `const` **cfDisableStyleProperties**: `"disable-style-properties"` = `'disable-style-properties'`

Enabling this component feature will hide the properties editor on the styles tab.


---

# Variable: cfDisableStyles

> `const` **cfDisableStyles**: `"disable-component-styling"` = `'disable-component-styling'`

Enabling this component feature will disable the styling of the component.


---

# Variable: cfDisableStylesForClassNameEditor

> `const` **cfDisableStylesForClassNameEditor**: `"disable-styles-for-classname-editor"` = `'disable-styles-for-classname-editor'`

Enabling this component feature will hide the 'Styles for className' editor.


---

# Variable: cfDisableTooltipProperties

> `const` **cfDisableTooltipProperties**: `"disable-tooltip-properties"` = `'disable-tooltip-properties'`

Enabling this component feature will hide the component tooltip properties editor.


---

# Variable: cfDisableWrapperStyles

> `const` **cfDisableWrapperStyles**: `"disable-component-wrapper-styling"` = `'disable-component-wrapper-styling'`

Enabling this component feature will disable the styling of the component wrapper.


---

# Variable: cfEnableInlineStylesEditor

> `const` **cfEnableInlineStylesEditor**: `"enable-inline-styles-editor"` = `'enable-inline-styles-editor'`

Enabling this component feature will show the 'Inline styles' editor.


---

# Variable: cfHideFromComponentPalette

> `const` **cfHideFromComponentPalette**: `"hide-from-component-palette"` = `'hide-from-component-palette'`

Enabling this component feature will hide it from the component palette.


---

# Variable: className

> `const` **className**: [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

The annotation builder for the component property containing the CSS class name.


---

# Variable: color

> `const` **color**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`>

The annotation builder for a component property with type 'color' (e.g. rgba(71, 167, 122, 0.72)).


---

# Variable: commonStyles

> `const` **commonStyles**: `object`

The annotations for generic CSS properties of a component.

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### backgroundColor[​](#backgroundcolor "Direct link to backgroundColor")

> **backgroundColor**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`> = `cssColor`

### color[​](#color "Direct link to color")

> **color**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`> = `cssColor`

### height[​](#height "Direct link to height")

> **height**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`> = `cssSize`

### marginBottom[​](#marginbottom "Direct link to marginBottom")

> **marginBottom**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`> = `cssSize`

### marginInlineEnd[​](#margininlineend "Direct link to marginInlineEnd")

> **marginInlineEnd**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`> = `cssSize`

### marginInlineStart[​](#margininlinestart "Direct link to marginInlineStart")

> **marginInlineStart**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`> = `cssSize`

### marginTop[​](#margintop "Direct link to marginTop")

> **marginTop**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`> = `cssSize`

### width[​](#width "Direct link to width")

> **width**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`>


---

# Variable: ComponentDataProvider

> **ComponentDataProvider**: `Provider`<[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)>

Context provider for the useComponentData hook. **Internal use only.**


---

# Variable: containerStyles

> `const` **containerStyles**: `object`

The annotations for generic CSS properties of a container component.

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### alignItems[​](#alignitems "Direct link to alignItems")

> **alignItems**: [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`"center"` | `"start"` | `"baseline"` | `"end"` | `"stretch"`>

### flexDirection[​](#flexdirection "Direct link to flexDirection")

> **flexDirection**: [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`"column"` | `"row"` | `"column-reverse"` | `"row-reverse"`>

### flexWrap[​](#flexwrap "Direct link to flexWrap")

> **flexWrap**: [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`"wrap"` | `"nowrap"` | `"wrap-reverse"`>

### gap[​](#gap "Direct link to gap")

> **gap**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`> = `size`

### justifyContent[​](#justifycontent "Direct link to justifyContent")

> **justifyContent**: [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`"left"` | `"right"` | `"center"` | `"start"` | `"end"` | `"flex-start"` | `"flex-end"` | `"space-between"` | `"space-around"` | `"space-evenly"`>


---

# Variable: coreComponentsDescriptions

> `const` **coreComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: createAnnotation()

> `const` **createAnnotation**: <`T`>(`editor`) => [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`T`> = `AnnotationBuilder.create`

Creates a component property metadata builder.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T`

the property type.

## Parameters[​](#parameters "Direct link to Parameters")

### editor[​](#editor "Direct link to editor")

`string`

the property editor type.

## Returns[​](#returns "Direct link to Returns")

[`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`T`>

the component property metadata builder.


---

# Variable: createView()

> `const` **createView**: (`models`) => [`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) = `View.create`

Static wrapper for the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) constructor.

## Parameters[​](#parameters "Direct link to Parameters")

### models[​](#models "Direct link to models")

[`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>\[]

the components metadata.

## Returns[​](#returns "Direct link to Returns")

[`View`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View)

the [View](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/View) instance.


---

# Variable: cssSize

> `const` **cssSize**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`>

The annotation builder for a component property containing a CSS dimension.


---

# Variable: date

> `const` **date**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `Date`>

The annotation builder for a component property with type 'Date'.


---

# Variable: DefaultWrapper

> `const` **DefaultWrapper**: `ForwardRefExoticComponent`<`any`> | `ForwardRefExoticComponent`<`Omit`<`any`, `"ref"`> & `RefAttributes`<`any`>>

The React component that wraps every component in a form.

## Param[​](#param "Direct link to Param")

the React component properties.

## Returns[​](#returns "Direct link to Returns")

the React element.


---

# Variable: define()

> `const` **define**: <`T`>(`component`, `displayName?`) => [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`T`> = `Definer.define`

Static method to create an instance of the component's metadata builder class.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### T[​](#t "Direct link to T")

`T` *extends* `object`

## Parameters[​](#parameters "Direct link to Parameters")

### component[​](#component "Direct link to component")

`ComponentType`<`T`>

the React component.

### displayName?[​](#displayname "Direct link to displayName?")

`string`

the display name for the anonymous component.

## Returns[​](#returns "Direct link to Returns")

[`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`T`>

the instance of the [Definer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer) class.


---

# Variable: definePreset()

> `const` **definePreset**: (`name`, `components`) => [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`object`> = `Definer.definePreset`

Static method to create an instance of the preset component's metadata builder class.

## Parameters[​](#parameters "Direct link to Parameters")

### name[​](#name "Direct link to name")

`string`

the preset name.

### components[​](#components "Direct link to components")

[`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)\[]

the components of the preset.

## Returns[​](#returns "Direct link to Returns")

[`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<`object`>

the instance of the [Definer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer) class.


---

# Variable: DidMountEvent

> `const` **DidMountEvent**: `"onDidMount"` = `'onDidMount'`

The DidMountEvent event name.


---

# Variable: disabled

> `const` **disabled**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `boolean`>

Annotation builder for a disabled property of a component with type 'boolean'.


---

# Variable: embeddedFormMeta

> `const` **embeddedFormMeta**: [`Meta`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Meta)


---

# Variable: embeddedFormModel

> `const` **embeddedFormModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`EmbeddedFormProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/EmbeddedFormProps)>


---

# Variable: emotionCache

> `const` **emotionCache**: `object`

The CSS style cache. **Internal use only.**

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### LTR[​](#ltr "Direct link to LTR")

> **LTR**: `EmotionCache`

### RTL[​](#rtl "Direct link to RTL")

> **RTL**: `EmotionCache`


---

# Variable: emptyComponentStore

> `const` **emptyComponentStore**: [`ComponentStore`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentStore)

The empty component settings object. **Internal use only.**


---

# Variable: errorMessageModel

> `const` **errorMessageModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)>

The component metadata for error message. **Internal use only.**


---

# Variable: event

> `const` **event**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<[`EventHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/EventHandler)>

The annotation builder for a component property with type 'event' (or event handler, or just a function).


---

# Variable: FormViewer()

> `const` **FormViewer**: (`props`) => `Element`

The main React component of the form viewer.

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`FormViewerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps)

the React component properties.

## Returns[​](#returns "Direct link to Returns")

`Element`

the React element.


---

# Variable: FormViewerLite()

> `const` **FormViewerLite**: (`props`) => `Element`

A lightweight version of the form viewer that uses NoopLocalizationEngine by default.

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`FormViewerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps)

the React component properties.

## Returns[​](#returns "Direct link to Returns")

`Element`

the React element.


---

# Variable: globalDefaultLanguage

> `const` **globalDefaultLanguage**: [`Language`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Language)

The default language for the application.


---

# Variable: htmlAttributes

> `const` **htmlAttributes**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`>

The annotation builder for the 'key' property of a component.


---

# Variable: IFormDataDeclaration

> `const` **IFormDataDeclaration**: "declare interface IFormData {\n /\*\*\n \* @returns the {@link Record} with all the form data.\n \*/\n get data(): Record\<string, unknown>\n\n /\*\*\n \* @returns the object to read and modify parent data (available for array elements).\n \*/\n get parentData(): Record\<string, unknown> | undefined\n\n /\*\*\n \* @returns the object to read and modify root form data.\n \*/\n get rootData(): Record\<string, unknown>\n\n /\*\*\n \* @returns the {@link Record} with all validation error messages.\n \*/\n get errors(): Record\<string, unknown>\n\n /\*\*\n \* true if the form contains errors, otherwise false.\n \*/\n get hasErrors(): boolean\n\n /\*\*\n \* @returns A user-defined key-value observable storage. Utilize it to store and share any custom data.\n \*/\n get state(): Record\<string, unknown>\n\n /\*\*\n \* Sets the validation error message for all form data fields.\n \* @param message the validation error message.\n \*/\n setAllErrors(message?: string): void\n\n /\*\*\n \* Validates the data in the form.\n \*/\n validate(): Promise\<void>\n\n /\*\*\n \* Returns the validation results without triggering an events and changing the state of the form.\n \* @returns the validation results.\n \*/\n getValidationResult: () => Promise\<ValidationMessages>\n\n /\*\*\n \* If true, then validation is in progress.\n \*/\n get isValidating(): boolean\n\n /\*\*\n \* Sets the form to its default value.\n \* @param clearInitialData if true, then also clear the initial data. Defaults to true.\n \*/\n reset(clearInitialData?: boolean): void\n\n /\*\*\n \* Clears the form data.\n \* @param clearInitialData if true, then also clear the initial data. Defaults to true.\n \*/\n clear(clearInitialData?: boolean): void\n\n /\*\*\n \* @returns the index in the array if the component is in the component array.\n \*/\n index?: number\n}"

Description of the form data for the code editor.


---

# Variable: internalErrorModel

> `const` **internalErrorModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<[`InternalErrorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/InternalErrorProps)>

**`Internal`**

Form viewer internal error metadata. **Internal use only.**


---

# Variable: isUniqueKey

> `const` **isUniqueKey**: [`RuleValidator`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator)<`string`>

Returns true if the component key is unique across the entire component tree. **Internal use only.**

## Param[​](#param "Direct link to Param")

the component key.

## Param[​](#param-1 "Direct link to Param")

the form viewer settings.

## Returns[​](#returns "Direct link to Returns")

true if the component key is unique across the entire component tree.


---

# Variable: key

> `const` **key**: [`Annotation`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Annotation)

The annotation for the 'key' property of the component.


---

# Variable: KeySymbol

> `const` **KeySymbol**: *typeof* `KeySymbol`

The unique Symbol for the key property.


---

# Variable: node

> `const` **node**: [`NodeAnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder)<`ReactNode`>

The annotation builder for a component property with type 'ReactNode'.


---

# Variable: nodeArray

> `const` **nodeArray**: [`NodeAnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder)<`ReactNode`\[]>

The annotation builder for a component property with type 'ReactNode\[]'.


---

# Variable: nonNegNumber

> `const` **nonNegNumber**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `number`>

The annotation builder for a component property with type 'number' that cannot be negative.


---

# Variable: number

> `const` **number**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `number`>

The annotation builder for a component property with type 'number'.


---

# Variable: object

> `const` **object**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `object`>

The annotation builder for a component property with type 'object'. It can accommodate any nested POJO that contains primitive values.


---

# Variable: oneOf()

> `const` **oneOf**: <`U`>(...`values`) => [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

The annotation builder for a component property with type 'enum', the property value can only be one of enum.

Sets the property as a "single select" property.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### U[​](#u "Direct link to U")

`U` *extends* `string` | `number`

## Parameters[​](#parameters "Direct link to Parameters")

### values[​](#values "Direct link to values")

...`U`\[]

the possible values for the property.

## Returns[​](#returns "Direct link to Returns")

[`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

the instance of the metadata property builder.


---

# Variable: oneOfStrict()

> `const` **oneOfStrict**: <`U`>(...`values`) => [`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

The annotation builder for a component property with type 'enum', the property value can only be one of enum. New values cannot be created (non-creatable).

Sets the property as a "single select" property.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### U[​](#u "Direct link to U")

`U` *extends* `string` | `number`

## Parameters[​](#parameters "Direct link to Parameters")

### values[​](#values "Direct link to values")

...`U`\[]

the possible values for the property.

## Returns[​](#returns "Direct link to Returns")

[`OneOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder)<`U`>

the instance of the metadata property builder.


---

# Variable: readOnly

> `const` **readOnly**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `boolean`>

Annotation builder for a read-only property of a component with type 'boolean'.


---

# Variable: renderWhen

> `const` **renderWhen**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `boolean`>

The annotation builder for the synthetic 'renderWhen' property of the component.


---

# Variable: required

> `const` **required**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `boolean`>

Annotation builder for a required property of a component with type 'boolean'.


---

# Variable: screenModel

> `const` **screenModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`Omit`<`any`, `"ref"`> & `RefAttributes`<`any`>>

Form viewer screen metadata. **Internal use only.**


---

# Variable: size

> `const` **size**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`>

The annotation builder for a component property with type 'CSS unit' (width, height, etc.).


---

# Variable: slotModel

> `const` **slotModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>

Form viewer slot metadata. **Internal use only.**


---

# Variable: someOf()

> `const` **someOf**: <`U`>(...`values`) => [`SomeOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)<`U`>

The annotation builder for a component property with type 'enum', the property value can contain multiple enum values.

Sets the property as a "multiple select" property.

## Type Parameters[​](#type-parameters "Direct link to Type Parameters")

### U[​](#u "Direct link to U")

`U` *extends* `string` | `number`

## Parameters[​](#parameters "Direct link to Parameters")

### values[​](#values "Direct link to values")

...`U`\[]

the possible values for the property.

## Returns[​](#returns "Direct link to Returns")

[`SomeOfBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder)<`U`>

the instance of the metadata property builder.


---

# Variable: StoreContext

> **StoreContext**: `Context`<`null` | [`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)>

**Internal use only.**


---

# Variable: StoreProvider

> **StoreProvider**: `Provider`<[`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)>

**Internal use only.**


---

# Variable: string

> `const` **string**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`>

The annotation builder for a component property with type 'string'.


---

# Variable: stringNode

> `const` **stringNode**: [`NodeAnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder)<`ReactNode`>

The annotation builder for a component property with type 'ReactNode'/'string'.


---

# Variable: time

> `const` **time**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`>

The annotation builder for a component property with type 'Time'.


---

# Variable: timeFormat

> `const` **timeFormat**: `"HH:mm:ss"` = `'HH:mm:ss'`

The string format for a value of the Time type.


---

# Variable: tooltipProps

> `const` **tooltipProps**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`>

The annotation builder for component tooltip properties.


---

# Variable: tooltipType

> `const` **tooltipType**: [`TypedBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder)<`undefined` | `string`>

The annotation builder for the form property describing the type of form tooltip.


---

# Variable: useBuilderMode()

> **useBuilderMode**: () => [`BuilderMode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderMode)

## Returns[​](#returns "Direct link to Returns")

[`BuilderMode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderMode)

the [BuilderMode](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderMode) builder mode value.


---

# Variable: useBuilderTheme()

> **useBuilderTheme**: () => [`BuilderTheme`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderTheme)

## Returns[​](#returns "Direct link to Returns")

[`BuilderTheme`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderTheme)

the current [BuilderTheme](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderTheme) value.


---

# Variable: useComponentData()

> **useComponentData**: () => [`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

## Returns[​](#returns "Direct link to Returns")

[`ComponentData`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ComponentData)

the instance of the ComponentData of the currently rendered component.


---

# Variable: useStore()

> **useStore**: () => [`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)

**Internal use only.**

## Returns[​](#returns "Direct link to Returns")

[`Store`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Store)


---

# Variable: useViewerProps()

> **useViewerProps**: () => `T`

**Internal use only.**

## Returns[​](#returns "Direct link to Returns")

`T`


---

# Variable: validation

> `const` **validation**: [`AnnotationBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder)<`unknown`>

The annotation builder for arbitrary HTML attributes of a component.


---

# Variable: ViewerPropsProvider

> **ViewerPropsProvider**: `Provider`<`Readonly`<[`FormViewerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps)>>

**Internal use only.**


---

# Variable: WillUnmountEvent

> `const` **WillUnmountEvent**: `"onWillUnmount"` = `'onWillUnmount'`

The WillUnmountEvent event name.


---

# @react-form-builder/designer-bundle

## Namespaces[​](#namespaces "Direct link to Namespaces")

* [fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/)
* [googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/)
* [richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/)
* [rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/)
* [rSuiteTableComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/)
* [signatureComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/)

## Classes[​](#classes "Direct link to Classes")

* [ActionDefinition](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/classes/ActionDefinition)
* [Language](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/classes/Language)

## Functions[​](#functions "Direct link to Functions")

* [buildForm](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/buildForm)
* [createBuilderView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/createBuilderView)
* [renderFormBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilder)
* [renderFormBuilderTo](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilderTo)


---

# Class: ActionDefinition

Represents the definition of an action.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new ActionDefinition**(`func`, `body?`, `params?`): `ActionDefinition`

Creates a new instance of the ActionDefinition class.

#### Parameters[​](#parameters "Direct link to Parameters")

##### func[​](#func "Direct link to func")

[`Func`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func)

the function of an action.

##### body?[​](#body "Direct link to body?")

`string`

the source code of the Action.

##### params?[​](#params "Direct link to params?")

[`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

#### Returns[​](#returns "Direct link to Returns")

`ActionDefinition`

## Properties[​](#properties "Direct link to Properties")

### body?[​](#body-1 "Direct link to body?")

> `readonly` `optional` **body**: `string`

the source code of the Action.

***

### func[​](#func-1 "Direct link to func")

> `readonly` **func**: [`Func`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func)

the function of an action.

***

### params[​](#params-1 "Direct link to params")

> `readonly` **params**: [`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

## Methods[​](#methods "Direct link to Methods")

### createFromObject()[​](#createfromobject "Direct link to createFromObject()")

> `static` **createFromObject**(`value`): `ActionDefinition`

Correctly creates the ActionDefinition from deserialized data.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the deserialized data.

#### Returns[​](#returns-1 "Direct link to Returns")

`ActionDefinition`

the ActionDefinition instance.

***

### functionalAction()[​](#functionalaction "Direct link to functionalAction()")

> `static` **functionalAction**(`func`, `params`): `ActionDefinition`

Creates an action from the function.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### func[​](#func-2 "Direct link to func")

[`Func`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/Func)

the function of an action.

##### params[​](#params-2 "Direct link to params")

[`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

#### Returns[​](#returns-2 "Direct link to Returns")

`ActionDefinition`

the new instance of the ActionDefinition class.

***

### sourceAction()[​](#sourceaction "Direct link to sourceAction()")

> `static` **sourceAction**(`body`, `params`): `ActionDefinition`

Creates an action from the source code.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### body[​](#body-2 "Direct link to body")

`string`

the source code of the Action.

##### params[​](#params-3 "Direct link to params")

[`ActionParameters`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters) = `{}`

the parameters of the Action.

#### Returns[​](#returns-3 "Direct link to Returns")

`ActionDefinition`

the new instance of the ActionDefinition class.


---

# Class: Language

The language to localize the form builder.

## Constructors[​](#constructors "Direct link to Constructors")

### Constructor[​](#constructor "Direct link to Constructor")

> **new Language**(`code`, `dialect`, `name`, `description`, `bidi`): `Language`

Creates a localization language for the form builder.

#### Parameters[​](#parameters "Direct link to Parameters")

##### code[​](#code "Direct link to code")

`string`

the language code, for example, 'en'.

##### dialect[​](#dialect "Direct link to dialect")

`string`

the dialect code, for example, 'US'.

##### name[​](#name "Direct link to name")

`string`

the name of the language, for example 'English'.

##### description[​](#description "Direct link to description")

`string`

the description of the language, for example 'American English'.

##### bidi[​](#bidi "Direct link to bidi")

[`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi) = `BiDi.LTR`

the type of text layout, for example, BiDi.LTR.

#### Returns[​](#returns "Direct link to Returns")

`Language`

## Properties[​](#properties "Direct link to Properties")

### bidi[​](#bidi-1 "Direct link to bidi")

> `readonly` **bidi**: [`BiDi`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/enumerations/BiDi) = `BiDi.LTR`

the type of text layout, for example, BiDi.LTR.

***

### code[​](#code-1 "Direct link to code")

> `readonly` **code**: `string`

the language code, for example, 'en'.

***

### description[​](#description-1 "Direct link to description")

> `readonly` **description**: `string`

the description of the language, for example 'American English'.

***

### dialect[​](#dialect-1 "Direct link to dialect")

> `readonly` **dialect**: `string`

the dialect code, for example, 'US'.

***

### name[​](#name-1 "Direct link to name")

> `readonly` **name**: `string`

the name of the language, for example 'English'.

## Accessors[​](#accessors "Direct link to Accessors")

### fullCode[​](#fullcode "Direct link to fullCode")

#### Get Signature[​](#get-signature "Direct link to Get Signature")

> **get** **fullCode**(): `` `${string}-${string}` ``

##### Returns[​](#returns-1 "Direct link to Returns")

`` `${string}-${string}` ``

the full code of the Language i.e. en-US, en-GB etc.

## Methods[​](#methods "Direct link to Methods")

### clone()[​](#clone "Direct link to clone()")

> `static` **clone**(`source`): `Language`

Clones an existing instance of the language.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### source[​](#source "Direct link to source")

`Language`

the cloning object.

#### Returns[​](#returns-2 "Direct link to Returns")

`Language`

the object clone.


---

# Function: buildForm()

> **buildForm**(`options?`): [`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

Creates and returns a new form JSON builder instance.

## Parameters[​](#parameters "Direct link to Parameters")

### options?[​](#options "Direct link to options?")

[`FormOptions`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/FormOptions)

the optional configuration options for the form.

## Returns[​](#returns "Direct link to Returns")

[`IFormJsonBuilder`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder)

the instance of [IFormJsonBuilder](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder) to start building the form.


---

# Function: createBuilderView()

> **createBuilderView**(`components`): [`BuilderView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView)

Creates metadata for form builder components.

## Parameters[​](#parameters "Direct link to Parameters")

### components[​](#components "Direct link to components")

[`BuilderComponent`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent)\[]

the array of metadata of form builder components.

## Returns[​](#returns "Direct link to Returns")

[`BuilderView`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView)

the [BuilderView](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/BuilderView) instance.


---

# Function: renderFormBuilder()

> **renderFormBuilder**(`elementId`, `props`): `Root`

Displays the FormBuilder component on the specified HTML element.

## Parameters[​](#parameters "Direct link to Parameters")

### elementId[​](#elementid "Direct link to elementId")

`string`

the HTML element identifier.

### props[​](#props "Direct link to props")

`Partial`<[`FormBuilderProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/FormBuilderProps)>

the component properties.

## Returns[​](#returns "Direct link to Returns")

`Root`

React Root.


---

# Function: renderFormBuilderTo()

> **renderFormBuilderTo**(`container`, `props`): `Root`

Displays the FormBuilder component on the specified HTML element.

## Parameters[​](#parameters "Direct link to Parameters")

### container[​](#container "Direct link to container")

`HTMLElement`

the HTML element.

### props[​](#props "Direct link to props")

`Partial`<[`FormBuilderProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/interfaces/FormBuilderProps)>

the component properties.

## Returns[​](#returns "Direct link to Returns")

`Root`

React Root.


---

# fastQrComponent

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [FastQrProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/interfaces/FastQrProps)

## Variables[​](#variables "Direct link to Variables")

* [fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrComponent)
* [fastQrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrComponentsDescriptions)
* [fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrEnUsComponentsDescriptions)
* [fastQrModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrModel)


---

# Interface: FastQrProps

The Fast QR component properties.

## Properties[​](#properties "Direct link to Properties")

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

***

### content[​](#content "Direct link to content")

> **content**: `string`

The QR code content.

***

### errorCorrectionLevel?[​](#errorcorrectionlevel "Direct link to errorCorrectionLevel?")

> `optional` **errorCorrectionLevel**: `number`

The error correction coding level.

***

### image?[​](#image "Direct link to image?")

> `optional` **image**: `string`

The image, base64 or URL.

***

### imageBackgroundColor?[​](#imagebackgroundcolor "Direct link to imageBackgroundColor?")

> `optional` **imageBackgroundColor**: `string`

The image background color.

***

### imageBackgroundShape?[​](#imagebackgroundshape "Direct link to imageBackgroundShape?")

> `optional` **imageBackgroundShape**: `number`

The image background shape.

***

### imageGap?[​](#imagegap "Direct link to imageGap?")

> `optional` **imageGap**: `number`

Image gap in module units.

***

### imagePositionX?[​](#imagepositionx "Direct link to imagePositionX?")

> `optional` **imagePositionX**: `number`

The image X position in module units.

***

### imagePositionY?[​](#imagepositiony "Direct link to imagePositionY?")

> `optional` **imagePositionY**: `number`

The image Y position in module units.

***

### imageSize?[​](#imagesize "Direct link to imageSize?")

> `optional` **imageSize**: `number`

Image size in module units.

***

### margin?[​](#margin "Direct link to margin?")

> `optional` **margin**: `number`

The margin.

***

### moduleColor?[​](#modulecolor "Direct link to moduleColor?")

> `optional` **moduleColor**: `string`

The module color.

***

### shape?[​](#shape "Direct link to shape?")

> `optional` **shape**: `number`

The different possible shapes to represent modules.

***

### version?[​](#version "Direct link to version?")

> `optional` **version**: `number`

The QR code version.

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `number`

The QR code width.


---

# Variable: fastQrComponent

> `const` **fastQrComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`FastQrProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/interfaces/FastQrProps)> = `fastQr`


---

# Variable: fastQrComponentsDescriptions

> `const` **fastQrComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: fastQrEnUsComponentsDescriptions

> **fastQrEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.static[​](#categoriesstatic "Direct link to categories.static")

> **categories.static**: `object`

#### categories.static.name[​](#categoriesstaticname "Direct link to categories.static.name")

> **categories.static.name**: `string` = `"Static"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.FastQR[​](#componentsfastqr "Direct link to components.FastQR")

> **components.FastQR**: `object`

#### components.FastQR.description[​](#componentsfastqrdescription "Direct link to components.FastQR.description")

> **components.FastQR.description**: `string` = `"Component that can convert text into QR codes, and support custom color and logo"`

#### components.FastQR.name[​](#componentsfastqrname "Direct link to components.FastQR.name")

> **components.FastQR.name**: `string` = `"QR Code"`

#### components.FastQR.props[​](#componentsfastqrprops "Direct link to components.FastQR.props")

> **components.FastQR.props**: `object`

#### components.FastQR.props.content[​](#componentsfastqrpropscontent "Direct link to components.FastQR.props.content")

> **components.FastQR.props.content**: `object`

#### components.FastQR.props.content.description[​](#componentsfastqrpropscontentdescription "Direct link to components.FastQR.props.content.description")

> **components.FastQR.props.content.description**: `string` = `"The QR code content"`

#### components.FastQR.props.content.name[​](#componentsfastqrpropscontentname "Direct link to components.FastQR.props.content.name")

> **components.FastQR.props.content.name**: `string` = `"Content"`

#### components.FastQR.props.errorCorrectionLevel[​](#componentsfastqrpropserrorcorrectionlevel "Direct link to components.FastQR.props.errorCorrectionLevel")

> **components.FastQR.props.errorCorrectionLevel**: `object`

#### components.FastQR.props.errorCorrectionLevel.description[​](#componentsfastqrpropserrorcorrectionleveldescription "Direct link to components.FastQR.props.errorCorrectionLevel.description")

> **components.FastQR.props.errorCorrectionLevel.description**: `string` = `"The error correction coding level"`

#### components.FastQR.props.errorCorrectionLevel.name[​](#componentsfastqrpropserrorcorrectionlevelname "Direct link to components.FastQR.props.errorCorrectionLevel.name")

> **components.FastQR.props.errorCorrectionLevel.name**: `string` = `"Error correction level"`

#### components.FastQR.props.image[​](#componentsfastqrpropsimage "Direct link to components.FastQR.props.image")

> **components.FastQR.props.image**: `object`

#### components.FastQR.props.image.description[​](#componentsfastqrpropsimagedescription "Direct link to components.FastQR.props.image.description")

> **components.FastQR.props.image.description**: `string` = `"The image, base64 or URL"`

#### components.FastQR.props.image.name[​](#componentsfastqrpropsimagename "Direct link to components.FastQR.props.image.name")

> **components.FastQR.props.image.name**: `string` = `"Image"`

#### components.FastQR.props.imageBackgroundColor[​](#componentsfastqrpropsimagebackgroundcolor "Direct link to components.FastQR.props.imageBackgroundColor")

> **components.FastQR.props.imageBackgroundColor**: `object`

#### components.FastQR.props.imageBackgroundColor.description[​](#componentsfastqrpropsimagebackgroundcolordescription "Direct link to components.FastQR.props.imageBackgroundColor.description")

> **components.FastQR.props.imageBackgroundColor.description**: `string` = `"The image background color"`

#### components.FastQR.props.imageBackgroundColor.name[​](#componentsfastqrpropsimagebackgroundcolorname "Direct link to components.FastQR.props.imageBackgroundColor.name")

> **components.FastQR.props.imageBackgroundColor.name**: `string` = `"Image background color"`

#### components.FastQR.props.imageBackgroundShape[​](#componentsfastqrpropsimagebackgroundshape "Direct link to components.FastQR.props.imageBackgroundShape")

> **components.FastQR.props.imageBackgroundShape**: `object`

#### components.FastQR.props.imageBackgroundShape.description[​](#componentsfastqrpropsimagebackgroundshapedescription "Direct link to components.FastQR.props.imageBackgroundShape.description")

> **components.FastQR.props.imageBackgroundShape.description**: `string` = `"The image background shape"`

#### components.FastQR.props.imageBackgroundShape.name[​](#componentsfastqrpropsimagebackgroundshapename "Direct link to components.FastQR.props.imageBackgroundShape.name")

> **components.FastQR.props.imageBackgroundShape.name**: `string` = `"Image background shape"`

#### components.FastQR.props.moduleColor[​](#componentsfastqrpropsmodulecolor "Direct link to components.FastQR.props.moduleColor")

> **components.FastQR.props.moduleColor**: `object`

#### components.FastQR.props.moduleColor.description[​](#componentsfastqrpropsmodulecolordescription "Direct link to components.FastQR.props.moduleColor.description")

> **components.FastQR.props.moduleColor.description**: `string` = `"The module color"`

#### components.FastQR.props.moduleColor.name[​](#componentsfastqrpropsmodulecolorname "Direct link to components.FastQR.props.moduleColor.name")

> **components.FastQR.props.moduleColor.name**: `string` = `"Module color"`

#### components.FastQR.props.shape[​](#componentsfastqrpropsshape "Direct link to components.FastQR.props.shape")

> **components.FastQR.props.shape**: `object`

#### components.FastQR.props.shape.description[​](#componentsfastqrpropsshapedescription "Direct link to components.FastQR.props.shape.description")

> **components.FastQR.props.shape.description**: `string` = `"The different possible shapes to represent modules"`

#### components.FastQR.props.shape.name[​](#componentsfastqrpropsshapename "Direct link to components.FastQR.props.shape.name")

> **components.FastQR.props.shape.name**: `string` = `"Shape"`

#### components.FastQR.props.version[​](#componentsfastqrpropsversion "Direct link to components.FastQR.props.version")

> **components.FastQR.props.version**: `object`

#### components.FastQR.props.version.description[​](#componentsfastqrpropsversiondescription "Direct link to components.FastQR.props.version.description")

> **components.FastQR.props.version.description**: `string` = `"The QR code version"`

#### components.FastQR.props.version.name[​](#componentsfastqrpropsversionname "Direct link to components.FastQR.props.version.name")

> **components.FastQR.props.version.name**: `string` = `"QR version"`

#### components.FastQR.props.width[​](#componentsfastqrpropswidth "Direct link to components.FastQR.props.width")

> **components.FastQR.props.width**: `object`

#### components.FastQR.props.width.description[​](#componentsfastqrpropswidthdescription "Direct link to components.FastQR.props.width.description")

> **components.FastQR.props.width.description**: `string` = `"The QR code width"`

#### components.FastQR.props.width.name[​](#componentsfastqrpropswidthname "Direct link to components.FastQR.props.width.name")

> **components.FastQR.props.width.name**: `string` = `"Width"`


---

# Variable: fastQrModel

> `const` **fastQrModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# googleMapComponent

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [GoogleMapProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/interfaces/GoogleMapProps)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

* [Address](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/Address)
* [MapMarker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/MapMarker)

## Variables[​](#variables "Direct link to Variables")

* [googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapComponent)
* [googleMapComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapComponentsDescriptions)
* [googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapEnUsComponentsDescriptions)
* [googleMapModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapModel)

## Functions[​](#functions "Direct link to Functions")

* [toAddress](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/functions/toAddress)


---

# Function: toAddress()

> **toAddress**(`components`): [`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/Address)

Converts the address components to an address object. Original source code from <https://developers.google.com/maps/documentation/javascript/examples/places-autocomplete-addressform>.

## Parameters[​](#parameters "Direct link to Parameters")

### components[​](#components "Direct link to components")

`GeocoderAddressComponent`\[]

the address components.

## Returns[​](#returns "Direct link to Returns")

[`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/Address)

the address object.


---

# Interface: GoogleMapProps

Props for the GoogleMap component.

## Properties[​](#properties "Direct link to Properties")

### addMarkerOnSearch[​](#addmarkeronsearch "Direct link to addMarkerOnSearch")

> **addMarkerOnSearch**: `boolean`

Whether to add a marker on search.

***

### allowChangingMarkers[​](#allowchangingmarkers "Direct link to allowChangingMarkers")

> **allowChangingMarkers**: `boolean`

If true, the user can change the markers.

***

### allowMultipleMarkers?[​](#allowmultiplemarkers "Direct link to allowMultipleMarkers?")

> `optional` **allowMultipleMarkers**: `boolean`

Whether multiple markers can be added to the map. Defaults to false.

***

### apiKey[​](#apikey "Direct link to apiKey")

> **apiKey**: `string`

Google Maps API key used to load the map.

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

***

### collisionBehavior?[​](#collisionbehavior "Direct link to collisionBehavior?")

> `optional` **collisionBehavior**: `CollisionBehavior`

The markers collision behavior.

***

### colorScheme?[​](#colorscheme "Direct link to colorScheme?")

> `optional` **colorScheme**: `"DARK"` | `"LIGHT"` | `"FOLLOW_SYSTEM"`

The color scheme to use for the map.

***

### gestureHandling?[​](#gesturehandling "Direct link to gestureHandling?")

> `optional` **gestureHandling**: `"none"` | `"auto"` | `"cooperative"` | `"greedy"`

This setting controls how the API handles gestures on the map.

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label of the component.

***

### language?[​](#language "Direct link to language?")

> `optional` **language**: `string`

Use a specific language for the map. Read more about localizing the Map: <https://developers.google.com/maps/documentation/javascript/localization>. Part of: <https://developers.google.com/maps/documentation/javascript/url-params>.

***

### latitude[​](#latitude "Direct link to latitude")

> **latitude**: `number`

Latitude of the center point on the map.

***

### longitude[​](#longitude "Direct link to longitude")

> **longitude**: `number`

Longitude of the center point on the map.

***

### mapControlPosition[​](#mapcontrolposition "Direct link to mapControlPosition")

> **mapControlPosition**: `ControlPosition`

The position of the map control.

***

### mapId?[​](#mapid "Direct link to mapId?")

> `optional` **mapId**: `string`

The map ID is an identifier that's associated with a specific map style or feature.

***

### mapTypeId[​](#maptypeid "Direct link to mapTypeId")

> **mapTypeId**: `"hybrid"` | `"roadmap"` | `"satellite"` | `"terrain"`

The default map type to use.

***

### markers?[​](#markers "Direct link to markers?")

> `optional` **markers**: [`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/MapMarker)\[]

Coordinates of the markers

***

### markerWindowTitle[​](#markerwindowtitle "Direct link to markerWindowTitle")

> **markerWindowTitle**: `string`

The title for the marker window.

***

### onMapClick()?[​](#onmapclick "Direct link to onMapClick()?")

> `optional` **onMapClick**: (`event`) => `void`

The callback function called when the map is clicked.

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`MapMouseEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### onMarkerAdd()?[​](#onmarkeradd "Direct link to onMarkerAdd()?")

> `optional` **onMarkerAdd**: (`marker`) => `void`

The callback function called when a marker is added.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### marker[​](#marker "Direct link to marker")

[`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/MapMarker)

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### onMarkerClick()?[​](#onmarkerclick "Direct link to onMarkerClick()?")

> `optional` **onMarkerClick**: (`marker`, `element`) => `void`

The callback function called when a marker is clicked.

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### marker[​](#marker-1 "Direct link to marker")

`null` | [`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/MapMarker)

##### element[​](#element "Direct link to element")

`AdvancedMarkerElement`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

***

### onMarkerDelete()?[​](#onmarkerdelete "Direct link to onMarkerDelete()?")

> `optional` **onMarkerDelete**: (`marker`) => `void`

The callback function called when a marker is deleted.

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### marker[​](#marker-2 "Direct link to marker")

[`MapMarker`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/MapMarker)

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

***

### onPlaceSelect()?[​](#onplaceselect "Direct link to onPlaceSelect()?")

> `optional` **onPlaceSelect**: (`place`, `address?`) => `void`

The callback function called when a place is selected.

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### place[​](#place "Direct link to place")

`PlaceResult`

the selected place.

##### address?[​](#address "Direct link to address?")

[`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/Address)

the address of the selected place.

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

***

### region?[​](#region "Direct link to region?")

> `optional` **region**: `string`

Sets the map to a specific region. Read more about localizing the Map: <https://developers.google.com/maps/documentation/javascript/localization>. Part of: <https://developers.google.com/maps/documentation/javascript/url-params>.

***

### removeMarkerCaption[​](#removemarkercaption "Direct link to removeMarkerCaption")

> **removeMarkerCaption**: `string`

The caption for the remove marker button.

***

### searchPlaceholder?[​](#searchplaceholder "Direct link to searchPlaceholder?")

> `optional` **searchPlaceholder**: `string`

The search input placeholder.

***

### showMapControl[​](#showmapcontrol "Direct link to showMapControl")

> **showMapControl**: `ControlPosition`

Whether to show the map control.

***

### zoom[​](#zoom "Direct link to zoom")

> **zoom**: `number`

Zoom level of the map.


---

# Type Alias: Address

> **Address** = `object`

Represents an address.

## Properties[​](#properties "Direct link to Properties")

### address?[​](#address "Direct link to address?")

> `optional` **address**: `string`

The first line of the address.

***

### city?[​](#city "Direct link to city?")

> `optional` **city**: `string`

The city of the address.

***

### country?[​](#country "Direct link to country?")

> `optional` **country**: `string`

The country of the address.

***

### postalCode?[​](#postalcode "Direct link to postalCode?")

> `optional` **postalCode**: `string`

The postal code of the address.

***

### state?[​](#state "Direct link to state?")

> `optional` **state**: `string`

The state of the address.


---

# Type Alias: MapMarker

> **MapMarker** = `object`

Represents the marker data on the map.

## Properties[​](#properties "Direct link to Properties")

### address?[​](#address "Direct link to address?")

> `optional` **address**: [`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/Address)

The address of the location.

***

### id[​](#id "Direct link to id")

> **id**: `string`

The unique identifier of the marker.

***

### position[​](#position "Direct link to position")

> **position**: `google.maps.LatLngLiteral`

Latitude and longitude of the geographical location.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

The title of the marker.

***

### zIndex[​](#zindex "Direct link to zIndex")

> **zIndex**: `number`

The z-index of the marker.


---

# Variable: googleMapComponent

> `const` **googleMapComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`GoogleMapProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/interfaces/GoogleMapProps)> = `googleMap`


---

# Variable: googleMapComponentsDescriptions

> `const` **googleMapComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: googleMapEnUsComponentsDescriptions

> **googleMapEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.fields[​](#categoriesfields "Direct link to categories.fields")

> **categories.fields**: `object`

#### categories.fields.name[​](#categoriesfieldsname "Direct link to categories.fields.name")

> **categories.fields.name**: `string` = `"Fields"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.GoogleMap[​](#componentsgooglemap "Direct link to components.GoogleMap")

> **components.GoogleMap**: `object`

#### components.GoogleMap.description[​](#componentsgooglemapdescription "Direct link to components.GoogleMap.description")

> **components.GoogleMap.description**: `string` = `"Component displaying a Google map"`

#### components.GoogleMap.name[​](#componentsgooglemapname "Direct link to components.GoogleMap.name")

> **components.GoogleMap.name**: `string` = `"Google Map"`

#### components.GoogleMap.props[​](#componentsgooglemapprops "Direct link to components.GoogleMap.props")

> **components.GoogleMap.props**: `object`

#### components.GoogleMap.props.addMarkerOnSearch[​](#componentsgooglemappropsaddmarkeronsearch "Direct link to components.GoogleMap.props.addMarkerOnSearch")

> **components.GoogleMap.props.addMarkerOnSearch**: `object`

#### components.GoogleMap.props.addMarkerOnSearch.description[​](#componentsgooglemappropsaddmarkeronsearchdescription "Direct link to components.GoogleMap.props.addMarkerOnSearch.description")

> **components.GoogleMap.props.addMarkerOnSearch.description**: `string` = `"Whether to add a marker on search"`

#### components.GoogleMap.props.addMarkerOnSearch.name[​](#componentsgooglemappropsaddmarkeronsearchname "Direct link to components.GoogleMap.props.addMarkerOnSearch.name")

> **components.GoogleMap.props.addMarkerOnSearch.name**: `string` = `"Add marker on search"`

#### components.GoogleMap.props.allowChangingMarkers[​](#componentsgooglemappropsallowchangingmarkers "Direct link to components.GoogleMap.props.allowChangingMarkers")

> **components.GoogleMap.props.allowChangingMarkers**: `object`

#### components.GoogleMap.props.allowChangingMarkers.description[​](#componentsgooglemappropsallowchangingmarkersdescription "Direct link to components.GoogleMap.props.allowChangingMarkers.description")

> **components.GoogleMap.props.allowChangingMarkers.description**: `string` = `"If checked, the user can change the markers"`

#### components.GoogleMap.props.allowChangingMarkers.name[​](#componentsgooglemappropsallowchangingmarkersname "Direct link to components.GoogleMap.props.allowChangingMarkers.name")

> **components.GoogleMap.props.allowChangingMarkers.name**: `string` = `"Allow changing markers"`

#### components.GoogleMap.props.allowMultipleMarkers[​](#componentsgooglemappropsallowmultiplemarkers "Direct link to components.GoogleMap.props.allowMultipleMarkers")

> **components.GoogleMap.props.allowMultipleMarkers**: `object`

#### components.GoogleMap.props.allowMultipleMarkers.description[​](#componentsgooglemappropsallowmultiplemarkersdescription "Direct link to components.GoogleMap.props.allowMultipleMarkers.description")

> **components.GoogleMap.props.allowMultipleMarkers.description**: `string` = `"Multiple markers"`

#### components.GoogleMap.props.allowMultipleMarkers.name[​](#componentsgooglemappropsallowmultiplemarkersname "Direct link to components.GoogleMap.props.allowMultipleMarkers.name")

> **components.GoogleMap.props.allowMultipleMarkers.name**: `string` = `"Allow multiple markers"`

#### components.GoogleMap.props.apiKey[​](#componentsgooglemappropsapikey "Direct link to components.GoogleMap.props.apiKey")

> **components.GoogleMap.props.apiKey**: `object`

#### components.GoogleMap.props.apiKey.description[​](#componentsgooglemappropsapikeydescription "Direct link to components.GoogleMap.props.apiKey.description")

> **components.GoogleMap.props.apiKey.description**: `string` = `"Google Maps API key"`

#### components.GoogleMap.props.apiKey.name[​](#componentsgooglemappropsapikeyname "Direct link to components.GoogleMap.props.apiKey.name")

> **components.GoogleMap.props.apiKey.name**: `string` = `"API key"`

#### components.GoogleMap.props.collisionBehavior[​](#componentsgooglemappropscollisionbehavior "Direct link to components.GoogleMap.props.collisionBehavior")

> **components.GoogleMap.props.collisionBehavior**: `object`

#### components.GoogleMap.props.collisionBehavior.description[​](#componentsgooglemappropscollisionbehaviordescription "Direct link to components.GoogleMap.props.collisionBehavior.description")

> **components.GoogleMap.props.collisionBehavior.description**: `string` = `"The markers collision behavior"`

#### components.GoogleMap.props.collisionBehavior.name[​](#componentsgooglemappropscollisionbehaviorname "Direct link to components.GoogleMap.props.collisionBehavior.name")

> **components.GoogleMap.props.collisionBehavior.name**: `string` = `"Collision behavior"`

#### components.GoogleMap.props.colorScheme[​](#componentsgooglemappropscolorscheme "Direct link to components.GoogleMap.props.colorScheme")

> **components.GoogleMap.props.colorScheme**: `object`

#### components.GoogleMap.props.colorScheme.description[​](#componentsgooglemappropscolorschemedescription "Direct link to components.GoogleMap.props.colorScheme.description")

> **components.GoogleMap.props.colorScheme.description**: `string` = `"The color scheme to use"`

#### components.GoogleMap.props.colorScheme.name[​](#componentsgooglemappropscolorschemename "Direct link to components.GoogleMap.props.colorScheme.name")

> **components.GoogleMap.props.colorScheme.name**: `string` = `"Color scheme"`

#### components.GoogleMap.props.gestureHandling[​](#componentsgooglemappropsgesturehandling "Direct link to components.GoogleMap.props.gestureHandling")

> **components.GoogleMap.props.gestureHandling**: `object`

#### components.GoogleMap.props.gestureHandling.description[​](#componentsgooglemappropsgesturehandlingdescription "Direct link to components.GoogleMap.props.gestureHandling.description")

> **components.GoogleMap.props.gestureHandling.description**: `string` = `"The gesture handling to use"`

#### components.GoogleMap.props.gestureHandling.name[​](#componentsgooglemappropsgesturehandlingname "Direct link to components.GoogleMap.props.gestureHandling.name")

> **components.GoogleMap.props.gestureHandling.name**: `string` = `"Gesture handling"`

#### components.GoogleMap.props.height[​](#componentsgooglemappropsheight "Direct link to components.GoogleMap.props.height")

> **components.GoogleMap.props.height**: `object`

#### components.GoogleMap.props.height.description[​](#componentsgooglemappropsheightdescription "Direct link to components.GoogleMap.props.height.description")

> **components.GoogleMap.props.height.description**: `string` = `"Height of the map"`

#### components.GoogleMap.props.height.name[​](#componentsgooglemappropsheightname "Direct link to components.GoogleMap.props.height.name")

> **components.GoogleMap.props.height.name**: `string` = `"Height"`

#### components.GoogleMap.props.label[​](#componentsgooglemappropslabel "Direct link to components.GoogleMap.props.label")

> **components.GoogleMap.props.label**: `object`

#### components.GoogleMap.props.label.description[​](#componentsgooglemappropslabeldescription "Direct link to components.GoogleMap.props.label.description")

> **components.GoogleMap.props.label.description**: `string` = `"Map label"`

#### components.GoogleMap.props.label.name[​](#componentsgooglemappropslabelname "Direct link to components.GoogleMap.props.label.name")

> **components.GoogleMap.props.label.name**: `string` = `"Label"`

#### components.GoogleMap.props.language[​](#componentsgooglemappropslanguage "Direct link to components.GoogleMap.props.language")

> **components.GoogleMap.props.language**: `object`

#### components.GoogleMap.props.language.description[​](#componentsgooglemappropslanguagedescription "Direct link to components.GoogleMap.props.language.description")

> **components.GoogleMap.props.language.description**: `string` = `"The language to use"`

#### components.GoogleMap.props.language.name[​](#componentsgooglemappropslanguagename "Direct link to components.GoogleMap.props.language.name")

> **components.GoogleMap.props.language.name**: `string` = `"Language"`

#### components.GoogleMap.props.latitude[​](#componentsgooglemappropslatitude "Direct link to components.GoogleMap.props.latitude")

> **components.GoogleMap.props.latitude**: `object`

#### components.GoogleMap.props.latitude.description[​](#componentsgooglemappropslatitudedescription "Direct link to components.GoogleMap.props.latitude.description")

> **components.GoogleMap.props.latitude.description**: `string` = `"Latitude of the center point"`

#### components.GoogleMap.props.latitude.name[​](#componentsgooglemappropslatitudename "Direct link to components.GoogleMap.props.latitude.name")

> **components.GoogleMap.props.latitude.name**: `string` = `"Latitude"`

#### components.GoogleMap.props.longitude[​](#componentsgooglemappropslongitude "Direct link to components.GoogleMap.props.longitude")

> **components.GoogleMap.props.longitude**: `object`

#### components.GoogleMap.props.longitude.description[​](#componentsgooglemappropslongitudedescription "Direct link to components.GoogleMap.props.longitude.description")

> **components.GoogleMap.props.longitude.description**: `string` = `"Longitude of the center point"`

#### components.GoogleMap.props.longitude.name[​](#componentsgooglemappropslongitudename "Direct link to components.GoogleMap.props.longitude.name")

> **components.GoogleMap.props.longitude.name**: `string` = `"Longitude"`

#### components.GoogleMap.props.mapControlPosition[​](#componentsgooglemappropsmapcontrolposition "Direct link to components.GoogleMap.props.mapControlPosition")

> **components.GoogleMap.props.mapControlPosition**: `object`

#### components.GoogleMap.props.mapControlPosition.description[​](#componentsgooglemappropsmapcontrolpositiondescription "Direct link to components.GoogleMap.props.mapControlPosition.description")

> **components.GoogleMap.props.mapControlPosition.description**: `string` = `"The position of the map control"`

#### components.GoogleMap.props.mapControlPosition.name[​](#componentsgooglemappropsmapcontrolpositionname "Direct link to components.GoogleMap.props.mapControlPosition.name")

> **components.GoogleMap.props.mapControlPosition.name**: `string` = `"Map control position"`

#### components.GoogleMap.props.mapId[​](#componentsgooglemappropsmapid "Direct link to components.GoogleMap.props.mapId")

> **components.GoogleMap.props.mapId**: `object`

#### components.GoogleMap.props.mapId.description[​](#componentsgooglemappropsmapiddescription "Direct link to components.GoogleMap.props.mapId.description")

> **components.GoogleMap.props.mapId.description**: `string` = `"The map ID is an identifier that's associated with a specific map style or feature"`

#### components.GoogleMap.props.mapId.name[​](#componentsgooglemappropsmapidname "Direct link to components.GoogleMap.props.mapId.name")

> **components.GoogleMap.props.mapId.name**: `string` = `"Map ID"`

#### components.GoogleMap.props.mapTypeId[​](#componentsgooglemappropsmaptypeid "Direct link to components.GoogleMap.props.mapTypeId")

> **components.GoogleMap.props.mapTypeId**: `object`

#### components.GoogleMap.props.mapTypeId.description[​](#componentsgooglemappropsmaptypeiddescription "Direct link to components.GoogleMap.props.mapTypeId.description")

> **components.GoogleMap.props.mapTypeId.description**: `string` = `"The default map type to use"`

#### components.GoogleMap.props.mapTypeId.name[​](#componentsgooglemappropsmaptypeidname "Direct link to components.GoogleMap.props.mapTypeId.name")

> **components.GoogleMap.props.mapTypeId.name**: `string` = `"Map type"`

#### components.GoogleMap.props.markers[​](#componentsgooglemappropsmarkers "Direct link to components.GoogleMap.props.markers")

> **components.GoogleMap.props.markers**: `object`

#### components.GoogleMap.props.markers.description[​](#componentsgooglemappropsmarkersdescription "Direct link to components.GoogleMap.props.markers.description")

> **components.GoogleMap.props.markers.description**: `string` = `"Coordinates of the markers"`

#### components.GoogleMap.props.markers.name[​](#componentsgooglemappropsmarkersname "Direct link to components.GoogleMap.props.markers.name")

> **components.GoogleMap.props.markers.name**: `string` = `"Markers"`

#### components.GoogleMap.props.markerWindowTitle[​](#componentsgooglemappropsmarkerwindowtitle "Direct link to components.GoogleMap.props.markerWindowTitle")

> **components.GoogleMap.props.markerWindowTitle**: `object`

#### components.GoogleMap.props.markerWindowTitle.description[​](#componentsgooglemappropsmarkerwindowtitledescription "Direct link to components.GoogleMap.props.markerWindowTitle.description")

> **components.GoogleMap.props.markerWindowTitle.description**: `string` = `"The title of the marker window"`

#### components.GoogleMap.props.markerWindowTitle.name[​](#componentsgooglemappropsmarkerwindowtitlename "Direct link to components.GoogleMap.props.markerWindowTitle.name")

> **components.GoogleMap.props.markerWindowTitle.name**: `string` = `"Marker window title"`

#### components.GoogleMap.props.region[​](#componentsgooglemappropsregion "Direct link to components.GoogleMap.props.region")

> **components.GoogleMap.props.region**: `object`

#### components.GoogleMap.props.region.description[​](#componentsgooglemappropsregiondescription "Direct link to components.GoogleMap.props.region.description")

> **components.GoogleMap.props.region.description**: `string` = `"The region code to use"`

#### components.GoogleMap.props.region.name[​](#componentsgooglemappropsregionname "Direct link to components.GoogleMap.props.region.name")

> **components.GoogleMap.props.region.name**: `string` = `"Region"`

#### components.GoogleMap.props.removeMarkerCaption[​](#componentsgooglemappropsremovemarkercaption "Direct link to components.GoogleMap.props.removeMarkerCaption")

> **components.GoogleMap.props.removeMarkerCaption**: `object`

#### components.GoogleMap.props.removeMarkerCaption.description[​](#componentsgooglemappropsremovemarkercaptiondescription "Direct link to components.GoogleMap.props.removeMarkerCaption.description")

> **components.GoogleMap.props.removeMarkerCaption.description**: `string` = `"The caption on the marker removal button"`

#### components.GoogleMap.props.removeMarkerCaption.name[​](#componentsgooglemappropsremovemarkercaptionname "Direct link to components.GoogleMap.props.removeMarkerCaption.name")

> **components.GoogleMap.props.removeMarkerCaption.name**: `string` = `"Remove marker caption"`

#### components.GoogleMap.props.searchPlaceholder[​](#componentsgooglemappropssearchplaceholder "Direct link to components.GoogleMap.props.searchPlaceholder")

> **components.GoogleMap.props.searchPlaceholder**: `object`

#### components.GoogleMap.props.searchPlaceholder.description[​](#componentsgooglemappropssearchplaceholderdescription "Direct link to components.GoogleMap.props.searchPlaceholder.description")

> **components.GoogleMap.props.searchPlaceholder.description**: `string` = `"Placeholder text for the map search input"`

#### components.GoogleMap.props.searchPlaceholder.name[​](#componentsgooglemappropssearchplaceholdername "Direct link to components.GoogleMap.props.searchPlaceholder.name")

> **components.GoogleMap.props.searchPlaceholder.name**: `string` = `"Search placeholder"`

#### components.GoogleMap.props.showMapControl[​](#componentsgooglemappropsshowmapcontrol "Direct link to components.GoogleMap.props.showMapControl")

> **components.GoogleMap.props.showMapControl**: `object`

#### components.GoogleMap.props.showMapControl.description[​](#componentsgooglemappropsshowmapcontroldescription "Direct link to components.GoogleMap.props.showMapControl.description")

> **components.GoogleMap.props.showMapControl.description**: `string` = `"Whether to show the map control"`

#### components.GoogleMap.props.showMapControl.name[​](#componentsgooglemappropsshowmapcontrolname "Direct link to components.GoogleMap.props.showMapControl.name")

> **components.GoogleMap.props.showMapControl.name**: `string` = `"Show map control"`

#### components.GoogleMap.props.width[​](#componentsgooglemappropswidth "Direct link to components.GoogleMap.props.width")

> **components.GoogleMap.props.width**: `object`

#### components.GoogleMap.props.width.description[​](#componentsgooglemappropswidthdescription "Direct link to components.GoogleMap.props.width.description")

> **components.GoogleMap.props.width.description**: `string` = `"Width of the map"`

#### components.GoogleMap.props.width.name[​](#componentsgooglemappropswidthname "Direct link to components.GoogleMap.props.width.name")

> **components.GoogleMap.props.width.name**: `string` = `"Width"`

#### components.GoogleMap.props.zoom[​](#componentsgooglemappropszoom "Direct link to components.GoogleMap.props.zoom")

> **components.GoogleMap.props.zoom**: `object`

#### components.GoogleMap.props.zoom.description[​](#componentsgooglemappropszoomdescription "Direct link to components.GoogleMap.props.zoom.description")

> **components.GoogleMap.props.zoom.description**: `string` = `"Zoom level"`

#### components.GoogleMap.props.zoom.name[​](#componentsgooglemappropszoomname "Direct link to components.GoogleMap.props.zoom.name")

> **components.GoogleMap.props.zoom.name**: `string` = `"Zoom"`


---

# Variable: googleMapModel

> `const` **googleMapModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# richTextComponent

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [RichTextEditorProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/interfaces/RichTextEditorProps)

## Variables[​](#variables "Direct link to Variables")

* [richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextComponent)
* [richTextEditorComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextEditorComponentsDescriptions)
* [richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextEditorEnUsComponentsDescriptions)
* [richTextModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextModel)


---

# Interface: RichTextEditorProps

The Rich text editor component properties.

## Extends[​](#extends "Direct link to Extends")

* `ReactQuillProps`

## Properties[​](#properties "Direct link to Properties")

### bounds?[​](#bounds "Direct link to bounds?")

> `optional` **bounds**: `string` | `HTMLElement`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.bounds`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactElement`<`any`, `string` | `JSXElementConstructor`<`any`>>

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

#### Overrides[​](#overrides "Direct link to Overrides")

`ReactQuill.ReactQuillProps.className`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `Value`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.defaultValue`

***

### formats?[​](#formats "Direct link to formats?")

> `optional` **formats**: `string`\[]

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.formats`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.id`

***

### initialValue?[​](#initialvalue "Direct link to initialValue?")

> `optional` **initialValue**: `string`

The initial value for the editor.

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the component.

***

### modules?[​](#modules "Direct link to modules?")

> `optional` **modules**: `Record`<`string`, `unknown`>

Allows to customize the behavior and functionality of the editor.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`ReactQuill.ReactQuillProps.modules`

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`value?`) => `void`

Triggered after the content changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value?[​](#value "Direct link to value?")

`string`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides-2 "Direct link to Overrides")

`ReactQuill.ReactQuillProps.onChange`

***

### onKeyDown()?[​](#onkeydown "Direct link to onKeyDown()?")

> `optional` **onKeyDown**: (`event`) => `void`

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`any`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onKeyDown`

***

### onKeyPress()?[​](#onkeypress "Direct link to onKeyPress()?")

> `optional` **onKeyPress**: (`event`) => `void`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### event[​](#event-1 "Direct link to event")

`any`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onKeyPress`

***

### onKeyUp()?[​](#onkeyup "Direct link to onKeyUp()?")

> `optional` **onKeyUp**: (`event`) => `void`

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`any`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onKeyUp`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.placeholder`

***

### preserveWhitespace?[​](#preservewhitespace "Direct link to preserveWhitespace?")

> `optional` **preserveWhitespace**: `boolean`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.preserveWhitespace`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.readOnly`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.style`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.tabIndex`

***

### theme?[​](#theme "Direct link to theme?")

> `optional` **theme**: `string`

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.theme`

***

### toolbarOptions?[​](#toolbaroptions "Direct link to toolbarOptions?")

> `optional` **toolbarOptions**: (`"block"` | `"color"` | `"direction"` | `"font"` | `"header"` | `"script"` | `"insert"` | `"size"` | `"list"` | `"clean"` | `"align"` | `"decoration"` | `"indent"`)\[]

Groups of buttons to be displayed on the toolbar.

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `Value`

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.value`

## Methods[​](#methods "Direct link to Methods")

### onBlur()?[​](#onblur "Direct link to onBlur()?")

> `optional` **onBlur**(`previousSelection`, `source`, `editor`): `void`

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### previousSelection[​](#previousselection "Direct link to previousSelection")

`Range`

##### source[​](#source "Direct link to source")

`EmitterSource`

##### editor[​](#editor "Direct link to editor")

`UnprivilegedEditor`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onBlur`

***

### onChangeSelection()?[​](#onchangeselection "Direct link to onChangeSelection()?")

> `optional` **onChangeSelection**(`selection`, `source`, `editor`): `void`

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### selection[​](#selection "Direct link to selection")

`Range`

##### source[​](#source-1 "Direct link to source")

`EmitterSource`

##### editor[​](#editor-1 "Direct link to editor")

`UnprivilegedEditor`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onChangeSelection`

***

### onFocus()?[​](#onfocus "Direct link to onFocus()?")

> `optional` **onFocus**(`selection`, `source`, `editor`): `void`

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### selection[​](#selection-1 "Direct link to selection")

`Range`

##### source[​](#source-2 "Direct link to source")

`EmitterSource`

##### editor[​](#editor-2 "Direct link to editor")

`UnprivilegedEditor`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ReactQuill.ReactQuillProps.onFocus`


---

# Variable: richTextComponent

> `const` **richTextComponent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer)<[`RichTextEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/interfaces/RichTextEditorProps)> = `richTextEditor`


---

# Variable: richTextEditorComponentsDescriptions

> `const` **richTextEditorComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription)>


---

# Variable: richTextEditorEnUsComponentsDescriptions

> **richTextEditorEnUsComponentsDescriptions**: `object`

## Type declaration[​](#type-declaration "Direct link to Type declaration")

### categories[​](#categories "Direct link to categories")

> **categories**: `object`

#### categories.fields[​](#categoriesfields "Direct link to categories.fields")

> **categories.fields**: `object`

#### categories.fields.name[​](#categoriesfieldsname "Direct link to categories.fields.name")

> **categories.fields.name**: `string` = `"Fields"`

### components[​](#components "Direct link to components")

> **components**: `object`

#### components.RichTextEditor[​](#componentsrichtexteditor "Direct link to components.RichTextEditor")

> **components.RichTextEditor**: `object`

#### components.RichTextEditor.description[​](#componentsrichtexteditordescription "Direct link to components.RichTextEditor.description")

> **components.RichTextEditor.description**: `string` = `"Your powerful rich text editor"`

#### components.RichTextEditor.name[​](#componentsrichtexteditorname "Direct link to components.RichTextEditor.name")

> **components.RichTextEditor.name**: `string` = `"Rich text editor"`

#### components.RichTextEditor.props[​](#componentsrichtexteditorprops "Direct link to components.RichTextEditor.props")

> **components.RichTextEditor.props**: `object`

#### components.RichTextEditor.props.initialValue[​](#componentsrichtexteditorpropsinitialvalue "Direct link to components.RichTextEditor.props.initialValue")

> **components.RichTextEditor.props.initialValue**: `object`

#### components.RichTextEditor.props.initialValue.description[​](#componentsrichtexteditorpropsinitialvaluedescription "Direct link to components.RichTextEditor.props.initialValue.description")

> **components.RichTextEditor.props.initialValue.description**: `string` = `"The initial value"`

#### components.RichTextEditor.props.initialValue.name[​](#componentsrichtexteditorpropsinitialvaluename "Direct link to components.RichTextEditor.props.initialValue.name")

> **components.RichTextEditor.props.initialValue.name**: `string` = `"Initial value"`

#### components.RichTextEditor.props.label[​](#componentsrichtexteditorpropslabel "Direct link to components.RichTextEditor.props.label")

> **components.RichTextEditor.props.label**: `object`

#### components.RichTextEditor.props.label.description[​](#componentsrichtexteditorpropslabeldescription "Direct link to components.RichTextEditor.props.label.description")

> **components.RichTextEditor.props.label.description**: `string` = `"The label"`

#### components.RichTextEditor.props.label.name[​](#componentsrichtexteditorpropslabelname "Direct link to components.RichTextEditor.props.label.name")

> **components.RichTextEditor.props.label.name**: `string` = `"Label"`

#### components.RichTextEditor.props.modules[​](#componentsrichtexteditorpropsmodules "Direct link to components.RichTextEditor.props.modules")

> **components.RichTextEditor.props.modules**: `object`

#### components.RichTextEditor.props.modules.description[​](#componentsrichtexteditorpropsmodulesdescription "Direct link to components.RichTextEditor.props.modules.description")

> **components.RichTextEditor.props.modules.description**: `string` = `"Allows to customize the behavior and functionality of the editor. Read docs for more info"`

#### components.RichTextEditor.props.modules.name[​](#componentsrichtexteditorpropsmodulesname "Direct link to components.RichTextEditor.props.modules.name")

> **components.RichTextEditor.props.modules.name**: `string` = `"Modules"`

#### components.RichTextEditor.props.placeholder[​](#componentsrichtexteditorpropsplaceholder "Direct link to components.RichTextEditor.props.placeholder")

> **components.RichTextEditor.props.placeholder**: `object`

#### components.RichTextEditor.props.placeholder.description[​](#componentsrichtexteditorpropsplaceholderdescription "Direct link to components.RichTextEditor.props.placeholder.description")

> **components.RichTextEditor.props.placeholder.description**: `string` = `"The placeholder"`

#### components.RichTextEditor.props.placeholder.name[​](#componentsrichtexteditorpropsplaceholdername "Direct link to components.RichTextEditor.props.placeholder.name")

> **components.RichTextEditor.props.placeholder.name**: `string` = `"Placeholder"`

#### components.RichTextEditor.props.readOnly[​](#componentsrichtexteditorpropsreadonly "Direct link to components.RichTextEditor.props.readOnly")

> **components.RichTextEditor.props.readOnly**: `object`

#### components.RichTextEditor.props.readOnly.description[​](#componentsrichtexteditorpropsreadonlydescription "Direct link to components.RichTextEditor.props.readOnly.description")

> **components.RichTextEditor.props.readOnly.description**: `string` = `"Read-only flag"`

#### components.RichTextEditor.props.readOnly.name[​](#componentsrichtexteditorpropsreadonlyname "Direct link to components.RichTextEditor.props.readOnly.name")

> **components.RichTextEditor.props.readOnly.name**: `string` = `"Read only"`

#### components.RichTextEditor.props.toolbarOptions[​](#componentsrichtexteditorpropstoolbaroptions "Direct link to components.RichTextEditor.props.toolbarOptions")

> **components.RichTextEditor.props.toolbarOptions**: `object`

#### components.RichTextEditor.props.toolbarOptions.description[​](#componentsrichtexteditorpropstoolbaroptionsdescription "Direct link to components.RichTextEditor.props.toolbarOptions.description")

> **components.RichTextEditor.props.toolbarOptions.description**: `string` = `"Groups of buttons to be displayed on the toolbar"`

#### components.RichTextEditor.props.toolbarOptions.name[​](#componentsrichtexteditorpropstoolbaroptionsname "Direct link to components.RichTextEditor.props.toolbarOptions.name")

> **components.RichTextEditor.props.toolbarOptions.name**: `string` = `"Toolbar options"`


---

# Variable: richTextModel

> `const` **richTextModel**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model)<`any`>


---

# rSuiteComponents

## Interfaces[​](#interfaces "Direct link to Interfaces")

* [RsAutoCompleteProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsAutoCompleteProps)
* [RsBreadcrumbItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps)
* [RsBreadcrumbProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbProps)
* [RsCalendarProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsCalendarProps)
* [RsCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsCardProps)
* [RsContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsContainerProps)
* [RsDatePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsDatePickerProps)
* [RsDropdownProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsDropdownProps)
* [RsErrorMessageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps)
* [RsHeaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsHeaderProps)
* [RsImageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsImageProps)
* [RsInputProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsInputProps)
* [RsLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsLabelProps)
* [RsLinkProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsLinkProps)
* [RsMenuProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsMenuProps)
* [RsModalLayoutProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsModalLayoutProps)
* [RsModalProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsModalProps)
* [RsNumberFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsNumberFormatProps)
* [RsPatternFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsPatternFormatProps)
* [RsRadioGroupProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsRadioGroupProps)
* [RsSearchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsSearchProps)
* [RsStaticContentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsStaticContentProps)
* [RsTabProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTabProps)
* [RsTagPickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTagPickerProps)
* [RsTextAreaProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTextAreaProps)
* [RsTimePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTimePickerProps)
* [RsTooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps)
* [RsUploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsUploaderProps)
* [RsWizardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardProps)
* [RsWizardStepProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardStepProps)

## Type Aliases[​](#type-aliases "Direct link to Type Aliases")

* [LoadCallback](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadCallback)
* [LoadDataHandler](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadDataHandler)
* [MenuItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/MenuItem)
* [RsTabItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/RsTabItem)

## Variables[​](#variables "Direct link to Variables")

* [builderViewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/builderViewWithCss)
* [components](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/components)
* [models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/models)
* [rsAutoComplete](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsAutoComplete)
* [rsBreadcrumb](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsBreadcrumb)
* [rsButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsButton)
* [rsCalendar](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCalendar)
* [rsCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCard)
* [rsCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCheckbox)
* [rsContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsContainer)
* [rsDatePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDatePicker)
* [rsDivider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDivider)
* [rsDropdown](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDropdown)
* [rsErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsErrorMessage)
* [rsHeader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsHeader)
* [rsImage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsImage)
* [rsInput](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsInput)
* [rsLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsLabel)
* [rsLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsLink)
* [rsMenu](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsMenu)
* [rsMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsMessage)
* [rsModal](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsModal)
* [rsModalLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsModalLayout)
* [rsNumberFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsNumberFormat)
* [rsPatternFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPatternFormat)
* [rsPlaceholderGraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGraph)
* [rsPlaceholderGrid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGrid)
* [rsPlaceholderParagraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderParagraph)
* [rsProgressCircle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsProgressCircle)
* [rsProgressLine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsProgressLine)
* [rsRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsRadioGroup)
* [rsSearch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsSearch)
* [rsStaticContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsStaticContent)
* [rsTab](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTab)
* [rsTagPicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTagPicker)
* [rsTextArea](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTextArea)
* [rsTimePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTimePicker)
* [rsToggle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsToggle)
* [rsTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTooltip)
* [rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponents)
* [rSuiteComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponentsDescriptions)
* [rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteEnUsComponentsDescriptions)
* [rsUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsUploader)
* [rsWizard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsWizard)
* [rsWizardStep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsWizardStep)
* [view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/view)
* [viewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/viewWithCss)

## Functions[​](#functions "Direct link to Functions")

* [formEngineRsuiteCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader)
* [ltrCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/ltrCssLoader)
* [RsLocalizationWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/RsLocalizationWrapper)
* [rtlCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/rtlCssLoader)


---

# Function: formEngineRsuiteCssLoader()

> **formEngineRsuiteCssLoader**(): `Promise`<`void`>

Loads FormEngine specific styles over "rsuite" library.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`>

the Promise that resolves when the custom styles have been loaded successfully.


---

# Function: ltrCssLoader()

> **ltrCssLoader**(): `Promise`<`void`>

Loads the Left-To-Right (LTR) CSS for the "rsuite" library.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`>

the Promise that resolves when the LTR CSS has been loaded successfully.


---

# Function: RsLocalizationWrapper()

> **RsLocalizationWrapper**(`props`): `Element`

Wrapper component for RSuite components localization.

## Parameters[​](#parameters "Direct link to Parameters")

### props[​](#props "Direct link to props")

[`FormViewerWrapperComponentProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerWrapperComponentProps)

the component props.

## Returns[​](#returns "Direct link to Returns")

`Element`

the wrapped components with localization settings applied.


---

# Function: rtlCssLoader()

> **rtlCssLoader**(): `Promise`<`void`>

Loads the Right-to-Left (RTL) CSS for the "rsuite" library.

## Returns[​](#returns "Direct link to Returns")

`Promise`<`void`>

the Promise that resolves when the RTL CSS has been loaded successfully.


---

# Interface: RsAutoCompleteProps

The properties of the RsAutoComplete component.

## Extends[​](#extends "Direct link to Extends")

* `AutoCompleteProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`AutoCompleteProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`AutoCompleteProps.as`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `string`

AutoComplete Content

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`AutoCompleteProps.autoComplete`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`AutoCompleteProps.block`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`AutoCompleteProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`AutoCompleteProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The component class name.

#### Overrides[​](#overrides "Direct link to Overrides")

`AutoCompleteProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`AutoCompleteProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`AutoCompleteProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`AutoCompleteProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`AutoCompleteProps.containerPadding`

***

### data[​](#data "Direct link to data")

> **data**: (`string` | `ItemDataType`<`string` | `number`>)\[]

The data of the component.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`AutoCompleteProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`AutoCompleteProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string`

Initial value

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`AutoCompleteProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`AutoCompleteProps.disabled`

***

### disabledItemValues?[​](#disableditemvalues "Direct link to disabledItemValues?")

> `optional` **disabledItemValues**: `string`\[]

Disabled items

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`AutoCompleteProps.disabledItemValues`

***

### filterBy()?[​](#filterby "Direct link to filterBy()?")

> `optional` **filterBy**: (`value`, `item`) => `boolean`

Custom filter function to determine whether the item will be displayed

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`string`

##### item[​](#item "Direct link to item")

`ItemDataType`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`AutoCompleteProps.filterBy`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`AutoCompleteProps.id`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The component label.

***

### labelKey?[​](#labelkey "Direct link to labelKey?")

> `optional` **labelKey**: `string`

The key to use for displaying the options in the data.

#### Default[​](#default-1 "Direct link to Default")

```
label
```

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`AutoCompleteProps.labelKey`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`any`>

Custom locale

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`AutoCompleteProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

The width of the menu will automatically follow the width of the input box

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`AutoCompleteProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

Additional classes for menu

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`AutoCompleteProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`AutoCompleteProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`AutoCompleteProps.menuStyle`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`AutoCompleteProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`Element`>

Called on blur

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`AutoCompleteProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`string`

the value.

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`AutoCompleteProps.onChange`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called on close

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`AutoCompleteProps.onClose`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`AutoCompleteProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`AutoCompleteProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`AutoCompleteProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`AutoCompleteProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`AutoCompleteProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`AutoCompleteProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`Element`>

Called on focus

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`AutoCompleteProps.onFocus`

***

### onKeyDown()?[​](#onkeydown "Direct link to onKeyDown()?")

> `optional` **onKeyDown**: (`event`) => `void`

The callback triggered by keyboard events.

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`KeyboardEvent`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`AutoCompleteProps.onKeyDown`

***

### onMenuFocus()?[​](#onmenufocus "Direct link to onMenuFocus()?")

> `optional` **onMenuFocus**: (`focusItemValue`, `event`) => `void`

Called on menu focus

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### focusItemValue[​](#focusitemvalue "Direct link to focusItemValue")

`any`

##### event[​](#event-1 "Direct link to event")

`KeyboardEvent`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`AutoCompleteProps.onMenuFocus`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called on open

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`AutoCompleteProps.onOpen`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`value`, `item`, `event`) => `void`

Called when a option is selected

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

##### item[​](#item-1 "Direct link to item")

`ItemDataType`

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`AutoCompleteProps.onSelect`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`AutoCompleteProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

Placeholder text

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`AutoCompleteProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of component

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`AutoCompleteProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`AutoCompleteProps.plaintext`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`AutoCompleteProps.preventOverflow`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`AutoCompleteProps.readOnly`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-13 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`AutoCompleteProps.renderExtraFooter`

***

### renderMenu()?[​](#rendermenu "Direct link to renderMenu()?")

> `optional` **renderMenu**: (`menu`) => `ReactNode`

Customizing the Rendering Menu list

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### menu[​](#menu "Direct link to menu")

`ReactNode`

#### Returns[​](#returns-14 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`AutoCompleteProps.renderMenu`

***

### renderMenuItem()?[​](#rendermenuitem "Direct link to renderMenuItem()?")

> `optional` **renderMenuItem**: (`label`, `item`) => `ReactNode`

Custom selected option

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### label[​](#label-1 "Direct link to label")

`ReactNode`

##### item[​](#item-2 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-15 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`AutoCompleteProps.renderMenuItem`

***

### selectOnEnter?[​](#selectonenter "Direct link to selectOnEnter?")

> `optional` **selectOnEnter**: `boolean`

When set to false, the Enter key selection function is invalid

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`AutoCompleteProps.selectOnEnter`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`AutoCompleteProps.size`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

The component styles.

#### Overrides[​](#overrides-2 "Direct link to Overrides")

`AutoCompleteProps.style`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`AutoCompleteProps.toggleAs`

***

### value?[​](#value-3 "Direct link to value?")

> `optional` **value**: `string`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`AutoCompleteProps.value`

***

### valueKey?[​](#valuekey "Direct link to valueKey?")

> `optional` **valueKey**: `string`

The key to use for setting the option value in the data.

#### Default[​](#default-2 "Direct link to Default")

```
value
```

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`AutoCompleteProps.valueKey`


---

# Interface: RsBreadcrumbItemProps

Props for a single breadcrumb item.

## Properties[​](#properties "Direct link to Properties")

### active?[​](#active "Direct link to active?")

> `optional` **active**: `boolean`

Whether the breadcrumb item is active.

***

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

URL for the breadcrumb item.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

Title text for the breadcrumb item.


---

# Interface: RsBreadcrumbProps

Props for the RsBreadcrumb component.

## Extends[​](#extends "Direct link to Extends")

* `BreadcrumbProps`

## Properties[​](#properties "Direct link to Properties")

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`BreadcrumbProps.as`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`BreadcrumbProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`BreadcrumbProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`BreadcrumbProps.classPrefix`

***

### ellipsis?[​](#ellipsis "Direct link to ellipsis?")

> `optional` **ellipsis**: `ReactNode`

The ellipsis element.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`BreadcrumbProps.ellipsis`

***

### items[​](#items "Direct link to items")

> **items**: [`RsBreadcrumbItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps)\[]

Array of breadcrumb items to display.

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `PickKeys`<{ `expandText`: `string`; }>

The locale of the component.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`BreadcrumbProps.locale`

***

### maxItems?[​](#maxitems "Direct link to maxItems?")

> `optional` **maxItems**: `number`

Set the maximum number of breadcrumbs to display. When there are more than the maximum number, only the first and last will be shown, with an ellipsis in between.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`BreadcrumbProps.maxItems`

***

### onExpand()?[​](#onexpand "Direct link to onExpand()?")

> `optional` **onExpand**: (`event`) => `void`

Callback function for clicking the ellipsis.

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`MouseEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`BreadcrumbProps.onExpand`

***

### onItemClick()[​](#onitemclick "Direct link to onItemClick()")

> **onItemClick**: (`item`) => `void`

Callback function when a breadcrumb item is clicked.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### item[​](#item "Direct link to item")

[`RsBreadcrumbItemProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps)

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

***

### separator?[​](#separator "Direct link to separator?")

> `optional` **separator**: `ReactNode`

The separator between each breadcrumb item.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`BreadcrumbProps.separator`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`BreadcrumbProps.style`


---

# Interface: RsCalendarProps

Props for the RsCalendar component.

## Extends[​](#extends "Direct link to Extends")

* `CalendarProps`

## Properties[​](#properties "Direct link to Properties")

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`CalendarProps.as`

***

### bordered?[​](#bordered "Direct link to bordered?")

> `optional` **bordered**: `boolean`

Show border

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`CalendarProps.bordered`

***

### cellClassName()?[​](#cellclassname "Direct link to cellClassName()?")

> `optional` **cellClassName**: (`date`) => `undefined` | `string`

Custom cell classes base on it's date

#### Parameters[​](#parameters "Direct link to Parameters")

##### date[​](#date "Direct link to date")

`Date`

#### Returns[​](#returns "Direct link to Returns")

`undefined` | `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`CalendarProps.cellClassName`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`CalendarProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`CalendarProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`CalendarProps.classPrefix`

***

### compact?[​](#compact "Direct link to compact?")

> `optional` **compact**: `boolean`

Display a compact calendar

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`CalendarProps.compact`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `Date`

Default value

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`CalendarProps.defaultValue`

***

### isoWeek?[​](#isoweek "Direct link to isoWeek?")

> `optional` **isoWeek**: `boolean`

ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day

#### See[​](#see "Direct link to See")

<https://en.wikipedia.org/wiki/ISO_week_date>

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`CalendarProps.isoWeek`

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

Label for the calendar.

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `CalendarLocale`

Custom locale object

#### See[​](#see-1 "Direct link to See")

<https://rsuitejs.com/guide/i18n/#calendar>

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`CalendarProps.locale`

***

### monthDropdownProps?[​](#monthdropdownprops "Direct link to monthDropdownProps?")

> `optional` **monthDropdownProps**: `MonthDropdownProps`

The props for the Month Dropdown component.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`CalendarProps.monthDropdownProps`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`date`) => `void`

Callback fired before the value changed

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### date[​](#date-1 "Direct link to date")

`Date`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`CalendarProps.onChange`

***

### onMonthChange()?[​](#onmonthchange "Direct link to onMonthChange()?")

> `optional` **onMonthChange**: (`date`) => `void`

Callback fired before the month changed @todo-Doma Change signature to `onMonthChange(year: number, month: number, reason: string)`?

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### date[​](#date-2 "Direct link to date")

`Date`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`CalendarProps.onMonthChange`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`date`) => `void`

Callback fired before the date selected

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### date[​](#date-3 "Direct link to date")

`Date`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`CalendarProps.onSelect`

***

### readOnly[​](#readonly "Direct link to readOnly")

> **readOnly**: `boolean`

Whether the calendar is read only.

***

### renderCell()?[​](#rendercell "Direct link to renderCell()?")

> `optional` **renderCell**: (`date`) => `ReactNode`

Custom render calendar cells

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### date[​](#date-4 "Direct link to date")

`Date`

#### Returns[​](#returns-4 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`CalendarProps.renderCell`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`CalendarProps.style`

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `Date`

Controlled value

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`CalendarProps.value`

***

### weekStart?[​](#weekstart "Direct link to weekStart?")

> `optional` **weekStart**: `0` | `3` | `1` | `2` | `4` | `5` | `6`

The index of the first day of the week (0 - Sunday) If `isoWeek` is `true`, the value of `weekStart` is ignored.

#### Default[​](#default "Direct link to Default")

```
0
```

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`CalendarProps.weekStart`


---

# Interface: RsCardProps

Props for the RsCard component.

## Extends[​](#extends "Direct link to Extends")

* `PanelProps`

## Properties[​](#properties "Direct link to Properties")

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`PanelProps.as`

***

### bodyFill?[​](#bodyfill "Direct link to bodyFill?")

> `optional` **bodyFill**: `boolean`

Content area filled with containers

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`PanelProps.bodyFill`

***

### bodyProps?[​](#bodyprops "Direct link to bodyProps?")

> `optional` **bodyProps**: `HTMLAttributes`<`HTMLDivElement`>

Custom body style

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`PanelProps.bodyProps`

***

### bordered?[​](#bordered "Direct link to bordered?")

> `optional` **bordered**: `boolean`

Show border

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`PanelProps.bordered`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

The icon on the right side of the title

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`PanelProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`PanelProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`PanelProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`PanelProps.classPrefix`

***

### collapsible?[​](#collapsible "Direct link to collapsible?")

> `optional` **collapsible**: `boolean`

Whether it is a collapsible panel

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`PanelProps.collapsible`

***

### defaultExpanded?[​](#defaultexpanded "Direct link to defaultExpanded?")

> `optional` **defaultExpanded**: `boolean`

Expand then panel by default

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`PanelProps.defaultExpanded`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Whether the panel is disabled

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`PanelProps.disabled`

***

### eventKey?[​](#eventkey "Direct link to eventKey?")

> `optional` **eventKey**: `string` | `number`

The event key corresponding to the panel

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`PanelProps.eventKey`

***

### expanded?[​](#expanded "Direct link to expanded?")

> `optional` **expanded**: `boolean`

Expand then panel

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`PanelProps.expanded`

***

### header?[​](#header "Direct link to header?")

> `optional` **header**: `ReactNode`

The head displays information

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`PanelProps.header`

***

### headerRole?[​](#headerrole "Direct link to headerRole?")

> `optional` **headerRole**: `string`

The role attribute of the header

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`PanelProps.headerRole`

***

### headerSize[​](#headersize "Direct link to headerSize")

> **headerSize**: `string`

Header size for the card.

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The id attribute of the panel

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`PanelProps.id`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`PanelProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`PanelProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`PanelProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`PanelProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`PanelProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`PanelProps.onExiting`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`eventKey`, `event`) => `void`

Called when the panel is selected

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### eventKey[​](#eventkey-1 "Direct link to eventKey")

`undefined` | `string` | `number`

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`PanelProps.onSelect`

***

### panelRole?[​](#panelrole "Direct link to panelRole?")

> `optional` **panelRole**: `string`

The role attribute of the panel

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`PanelProps.panelRole`

***

### scrollShadow?[​](#scrollshadow "Direct link to scrollShadow?")

> `optional` **scrollShadow**: `boolean`

The shadow of the content when scrolling

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`PanelProps.scrollShadow`

***

### shaded?[​](#shaded "Direct link to shaded?")

> `optional` **shaded**: `boolean`

Whether there is a shadow

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`PanelProps.shaded`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`PanelProps.style`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

Title for the card.


---

# Interface: RsContainerProps

Props for the RsContainer component.

## Properties[​](#properties "Direct link to Properties")

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Children elements of the container.

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Whether the container is disabled.

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Whether the container is read only.


---

# Interface: RsDatePickerProps

Props for the RsDatePicker component.

## Extends[​](#extends "Direct link to Extends")

* `DatePickerProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`DatePickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`DatePickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`DatePickerProps.block`

***

### calendarDefaultDate?[​](#calendardefaultdate "Direct link to calendarDefaultDate?")

> `optional` **calendarDefaultDate**: `Date`

Calendar panel default presentation date and time

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`DatePickerProps.calendarDefaultDate`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `null` | `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`DatePickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`DatePickerProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`DatePickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`DatePickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`DatePickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`DatePickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`DatePickerProps.containerPadding`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`DatePickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `null` | `Date`

Initial value

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`DatePickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Whether disabled the component

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`DatePickerProps.disabled`

***

### ~~disabledDate()?~~[​](#disableddate "Direct link to disableddate")

> `optional` **disabledDate**: (`date?`) => `boolean`

Whether to disable a date on the calendar view

#### Parameters[​](#parameters "Direct link to Parameters")

##### date?[​](#date "Direct link to date?")

`Date`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

date should be disabled (not selectable)

#### Deprecated[​](#deprecated "Direct link to Deprecated")

Use [shouldDisableDate](#shoulddisabledate) instead

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`DatePickerProps.disabledDate`

***

### ~~disabledHours()?~~[​](#disabledhours "Direct link to disabledhours")

> `optional` **disabledHours**: (`hour`, `date`) => `boolean`

Disabled hours

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### hour[​](#hour "Direct link to hour")

`number`

##### date[​](#date-1 "Direct link to date")

`Date`

#### Returns[​](#returns-1 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

Use [shouldDisableHour](#shoulddisablehour) instead

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`DatePickerProps.disabledHours`

***

### ~~disabledMinutes()?~~[​](#disabledminutes "Direct link to disabledminutes")

> `optional` **disabledMinutes**: (`minute`, `date`) => `boolean`

Disabled minutes

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### minute[​](#minute "Direct link to minute")

`number`

##### date[​](#date-2 "Direct link to date")

`Date`

#### Returns[​](#returns-2 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use [shouldDisableMinute](#shoulddisableminute) instead

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`DatePickerProps.disabledMinutes`

***

### ~~disabledSeconds()?~~[​](#disabledseconds "Direct link to disabledseconds")

> `optional` **disabledSeconds**: (`second`, `date`) => `boolean`

Disabled seconds

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### second[​](#second "Direct link to second")

`number`

##### date[​](#date-3 "Direct link to date")

`Date`

#### Returns[​](#returns-3 "Direct link to Returns")

`boolean`

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use [shouldDisableSecond](#shoulddisablesecond) instead

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`DatePickerProps.disabledSeconds`

***

### editable?[​](#editable "Direct link to editable?")

> `optional` **editable**: `boolean`

Rendered as an input, the date can be entered via the keyboard

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`DatePickerProps.editable`

***

### format?[​](#format "Direct link to format?")

> `optional` **format**: `string`

Format date string

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`DatePickerProps.format`

***

### hideHours()?[​](#hidehours "Direct link to hideHours()?")

> `optional` **hideHours**: (`hour`, `date`) => `boolean`

Hide specific hour options

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### hour[​](#hour-1 "Direct link to hour")

`number`

##### date[​](#date-4 "Direct link to date")

`Date`

#### Returns[​](#returns-4 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`DatePickerProps.hideHours`

***

### hideMinutes()?[​](#hideminutes "Direct link to hideMinutes()?")

> `optional` **hideMinutes**: (`minute`, `date`) => `boolean`

Hide specific minute options

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### minute[​](#minute-1 "Direct link to minute")

`number`

##### date[​](#date-5 "Direct link to date")

`Date`

#### Returns[​](#returns-5 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`DatePickerProps.hideMinutes`

***

### hideSeconds()?[​](#hideseconds "Direct link to hideSeconds()?")

> `optional` **hideSeconds**: (`second`, `date`) => `boolean`

Hide specific second options

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### second[​](#second-1 "Direct link to second")

`number`

##### date[​](#date-6 "Direct link to date")

`Date`

#### Returns[​](#returns-6 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`DatePickerProps.hideSeconds`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`DatePickerProps.id`

***

### ~~inline?~~[​](#inline "Direct link to inline")

> `optional` **inline**: `boolean`

#### Deprecated[​](#deprecated-4 "Direct link to Deprecated")

#### Overrides[​](#overrides "Direct link to Overrides")

`DatePickerProps.inline`

***

### isoWeek?[​](#isoweek "Direct link to isoWeek?")

> `optional` **isoWeek**: `boolean`

ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day

#### See[​](#see "Direct link to See")

<https://en.wikipedia.org/wiki/ISO_week_date>

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`DatePickerProps.isoWeek`

***

### label[​](#label "Direct link to label")

> **label**: `string`

Label for the date picker.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`DatePickerProps.label`

***

### limitEndYear?[​](#limitendyear "Direct link to limitEndYear?")

> `optional` **limitEndYear**: `number`

Set the upper limit of the available year relative to the current selection date

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`DatePickerProps.limitEndYear`

***

### limitStartYear?[​](#limitstartyear "Direct link to limitStartYear?")

> `optional` **limitStartYear**: `number`

Set the lower limit of the available year relative to the current selection date

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`DatePickerProps.limitStartYear`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display a loading state indicator

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`DatePickerProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`DatePickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`DatePickerProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`DatePickerProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`DatePickerProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`DatePickerProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`DatePickerProps.menuStyle`

***

### monthDropdownProps?[​](#monthdropdownprops "Direct link to monthDropdownProps?")

> `optional` **monthDropdownProps**: `MonthDropdownProps`

The props for the Month Dropdown component.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`DatePickerProps.monthDropdownProps`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`DatePickerProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`any`>

Called when the component is blurred.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`DatePickerProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

the value.

`null` | `Date`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-2 "Direct link to Overrides")

`DatePickerProps.onChange`

***

### onChangeCalendarDate()?[​](#onchangecalendardate "Direct link to onChangeCalendarDate()?")

> `optional` **onChangeCalendarDate**: (`date`, `event?`) => `void`

Called when the calendar panel date changes

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### date[​](#date-7 "Direct link to date")

`Date`

##### event?[​](#event "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`DatePickerProps.onChangeCalendarDate`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-1 "Direct link to event")

`MouseEvent`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`DatePickerProps.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`DatePickerProps.onClose`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`DatePickerProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`DatePickerProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`DatePickerProps.onEntering`

***

### oneTap?[​](#onetap "Direct link to oneTap?")

> `optional` **oneTap**: `boolean`

One-click selection date

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`DatePickerProps.oneTap`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-14 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`DatePickerProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-15 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`DatePickerProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-16 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`DatePickerProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`any`>

Called when the component is focused.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`DatePickerProps.onFocus`

***

### onNextMonth()?[​](#onnextmonth "Direct link to onNextMonth()?")

> `optional` **onNextMonth**: (`date`) => `void`

Called after the next month

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### date[​](#date-8 "Direct link to date")

`Date`

#### Returns[​](#returns-17 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`DatePickerProps.onNextMonth`

***

### onOk()?[​](#onok "Direct link to onOk()?")

> `optional` **onOk**: (`date`, `event`) => `void`

Called after clicking the OK button

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### date[​](#date-9 "Direct link to date")

`Date`

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-18 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`DatePickerProps.onOk`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-19 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`DatePickerProps.onOpen`

***

### onPrevMonth()?[​](#onprevmonth "Direct link to onPrevMonth()?")

> `optional` **onPrevMonth**: (`date`) => `void`

Called after the prev month

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### date[​](#date-10 "Direct link to date")

`Date`

#### Returns[​](#returns-20 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`DatePickerProps.onPrevMonth`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`date`, `event?`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-19 "Direct link to Parameters")

##### date[​](#date-11 "Direct link to date")

`Date`

##### event?[​](#event-3 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-21 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`DatePickerProps.onSelect`

***

### onShortcutClick()?[​](#onshortcutclick "Direct link to onShortcutClick()?")

> `optional` **onShortcutClick**: (`range`, `event`) => `void`

Called after clicking the shortcut button

#### Parameters[​](#parameters-20 "Direct link to Parameters")

##### range[​](#range "Direct link to range")

`RangeType`<`Date`>

##### event[​](#event-4 "Direct link to event")

`MouseEvent`

#### Returns[​](#returns-22 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`DatePickerProps.onShortcutClick`

***

### onToggleMonthDropdown()?[​](#ontogglemonthdropdown "Direct link to onToggleMonthDropdown()?")

> `optional` **onToggleMonthDropdown**: (`toggle`) => `void`

Called when opening the month view

#### Parameters[​](#parameters-21 "Direct link to Parameters")

##### toggle[​](#toggle "Direct link to toggle")

`boolean`

#### Returns[​](#returns-23 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`DatePickerProps.onToggleMonthDropdown`

***

### onToggleTimeDropdown()?[​](#ontoggletimedropdown "Direct link to onToggleTimeDropdown()?")

> `optional` **onToggleTimeDropdown**: (`toggle`) => `void`

Called when opening the time view

#### Parameters[​](#parameters-22 "Direct link to Parameters")

##### toggle[​](#toggle-1 "Direct link to toggle")

`boolean`

#### Returns[​](#returns-24 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`DatePickerProps.onToggleTimeDropdown`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`DatePickerProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`DatePickerProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`DatePickerProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Whether plaintext the component

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`DatePickerProps.plaintext`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`DatePickerProps.preventOverflow`

***

### ranges?[​](#ranges "Direct link to ranges?")

> `optional` **ranges**: `RangeType`<`Date`>\[]

Predefined date Ranges

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`DatePickerProps.ranges`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Whether read only the component

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`DatePickerProps.readOnly`

***

### renderCell()?[​](#rendercell "Direct link to renderCell()?")

> `optional` **renderCell**: (`date`) => `ReactNode`

Custom rendering calendar cell content.

#### Parameters[​](#parameters-23 "Direct link to Parameters")

##### date[​](#date-12 "Direct link to date")

`Date`

#### Returns[​](#returns-25 "Direct link to Returns")

`ReactNode`

#### Version[​](#version "Direct link to Version")

5.54.0

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`DatePickerProps.renderCell`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-26 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`DatePickerProps.renderExtraFooter`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`, `format`) => `string`

Custom rendering of the selected date.

#### Parameters[​](#parameters-24 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`Date`

##### format[​](#format-1 "Direct link to format")

`string`

#### Returns[​](#returns-27 "Direct link to Returns")

`string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`DatePickerProps.renderValue`

***

### shouldDisableDate()?[​](#shoulddisabledate "Direct link to shouldDisableDate()?")

> `optional` **shouldDisableDate**: (`date`) => `boolean`

Whether a date on the calendar view should be disabled

#### Parameters[​](#parameters-25 "Direct link to Parameters")

##### date[​](#date-13 "Direct link to date")

`Date`

#### Returns[​](#returns-28 "Direct link to Returns")

`boolean`

date should be disabled (not selectable)

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`DatePickerProps.shouldDisableDate`

***

### shouldDisableHour()?[​](#shoulddisablehour "Direct link to shouldDisableHour()?")

> `optional` **shouldDisableHour**: (`hour`, `date`) => `boolean`

Disabled hours on the time view

#### Parameters[​](#parameters-26 "Direct link to Parameters")

##### hour[​](#hour-2 "Direct link to hour")

`number`

##### date[​](#date-14 "Direct link to date")

`Date`

#### Returns[​](#returns-29 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`DatePickerProps.shouldDisableHour`

***

### shouldDisableMinute()?[​](#shoulddisableminute "Direct link to shouldDisableMinute()?")

> `optional` **shouldDisableMinute**: (`minute`, `date`) => `boolean`

Disabled minutes on the time view

#### Parameters[​](#parameters-27 "Direct link to Parameters")

##### minute[​](#minute-2 "Direct link to minute")

`number`

##### date[​](#date-15 "Direct link to date")

`Date`

#### Returns[​](#returns-30 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`DatePickerProps.shouldDisableMinute`

***

### shouldDisableSecond()?[​](#shoulddisablesecond "Direct link to shouldDisableSecond()?")

> `optional` **shouldDisableSecond**: (`second`, `date`) => `boolean`

Disabled seconds on the time view

#### Parameters[​](#parameters-28 "Direct link to Parameters")

##### second[​](#second-2 "Direct link to second")

`number`

##### date[​](#date-16 "Direct link to date")

`Date`

#### Returns[​](#returns-31 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`DatePickerProps.shouldDisableSecond`

***

### ~~showMeridian?~~[​](#showmeridian "Direct link to showmeridian")

> `optional` **showMeridian**: `boolean`

#### Deprecated[​](#deprecated-5 "Direct link to Deprecated")

Use `showMeridiem` instead

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`DatePickerProps.showMeridian`

***

### showMeridiem?[​](#showmeridiem "Direct link to showMeridiem?")

> `optional` **showMeridiem**: `boolean`

Meridiem format for 12-hour time

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`DatePickerProps.showMeridiem`

***

### showWeekNumbers?[​](#showweeknumbers "Direct link to showWeekNumbers?")

> `optional` **showWeekNumbers**: `boolean`

Whether to show week numbers

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`DatePickerProps.showWeekNumbers`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`DatePickerProps.size`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`DatePickerProps.style`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`DatePickerProps.toggleAs`

***

### value?[​](#value-2 "Direct link to value?")

> `optional` **value**: `null` | `Date`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`DatePickerProps.value`

***

### weekStart?[​](#weekstart "Direct link to weekStart?")

> `optional` **weekStart**: `0` | `3` | `1` | `2` | `4` | `5` | `6`

The index of the first day of the week (0 - Sunday) If `isoWeek` is `true`, the value of `weekStart` is ignored.

#### Default[​](#default "Direct link to Default")

```
0
```

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`DatePickerProps.weekStart`


---

# Interface: RsDropdownProps

Props for the RsDropdown component.

## Extends[​](#extends "Direct link to Extends")

* `InputPickerProps`.`LoadDataProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`InputPickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`InputPickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`InputPickerProps.block`

***

### cacheData?[​](#cachedata "Direct link to cacheData?")

> `optional` **cacheData**: `InputItemDataType`<`any`>\[]

Option to cache value when searching asynchronously

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`InputPickerProps.cacheData`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`InputPickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`InputPickerProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`InputPickerProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`InputPickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`InputPickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`InputPickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`InputPickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`InputPickerProps.containerPadding`

***

### creatable?[​](#creatable "Direct link to creatable?")

> `optional` **creatable**: `boolean`

Settings can create new options

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`InputPickerProps.creatable`

***

### data[​](#data "Direct link to data")

> **data**: `InputItemDataType`<`string` | `number`>\[]

The data of the component.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`InputPickerProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`InputPickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `any`

Initial value

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`InputPickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`InputPickerProps.disabled`

***

### disabledItemValues?[​](#disableditemvalues "Direct link to disabledItemValues?")

> `optional` **disabledItemValues**: `any`

Disabled items

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`InputPickerProps.disabledItemValues`

***

### disableVirtualized?[​](#disablevirtualized "Direct link to disableVirtualized?")

> `optional` **disableVirtualized**: `boolean`

Flag, if true, the virtualized will be disabled, false otherwise.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`LoadDataProps.disableVirtualized`

***

### groupBy?[​](#groupby "Direct link to groupBy?")

> `optional` **groupBy**: `string`

Set group condition key in data

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`InputPickerProps.groupBy`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`InputPickerProps.id`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the dropdown.

***

### labelKey?[​](#labelkey "Direct link to labelKey?")

> `optional` **labelKey**: `string`

The key to use for displaying the options in the data.

#### Default[​](#default-1 "Direct link to Default")

```
label
```

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`InputPickerProps.labelKey`

***

### listProps?[​](#listprops "Direct link to listProps?")

> `optional` **listProps**: `Partial`<`ListProps`<`any`>>

Virtualized List Props

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`InputPickerProps.listProps`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display an loading indicator on toggle button

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`InputPickerProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`InputPickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`InputPickerProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`InputPickerProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`InputPickerProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`InputPickerProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`InputPickerProps.menuStyle`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`InputPickerProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`Element`>

The `onBlur` attribute for the `input` element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`InputPickerProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the value.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides "Direct link to Overrides")

`InputPickerProps.onChange`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`InputPickerProps.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`InputPickerProps.onClose`

***

### onCreate()?[​](#oncreate "Direct link to onCreate()?")

> `optional` **onCreate**: (`value`, `item`, `event`) => `void`

Called when the option is created

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`any`

##### item[​](#item "Direct link to item")

`ItemDataType`

##### event[​](#event-1 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`InputPickerProps.onCreate`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`InputPickerProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`InputPickerProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`InputPickerProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`InputPickerProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`InputPickerProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`InputPickerProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`Element`>

The `onFocus` attribute for the `input` element.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`InputPickerProps.onFocus`

***

### onGroupTitleClick()?[​](#ongrouptitleclick "Direct link to onGroupTitleClick()?")

> `optional` **onGroupTitleClick**: (`event`) => `void`

Called after clicking the group title

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`InputPickerProps.onGroupTitleClick`

***

### onLoadData?[​](#onloaddata "Direct link to onLoadData?")

> `optional` **onLoadData**: [`LoadDataHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadDataHandler)

The callback function called when data should be load.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`LoadDataProps.onLoadData`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`InputPickerProps.onOpen`

***

### onSearch()?[​](#onsearch "Direct link to onSearch()?")

> `optional` **onSearch**: (`searchKeyword`, `event?`) => `void`

Called when searching

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword "Direct link to searchKeyword")

`string`

##### event?[​](#event-3 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`InputPickerProps.onSearch`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`value`, `item`, `event`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

##### item[​](#item-1 "Direct link to item")

`ItemDataType`<`any`>

##### event[​](#event-4 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`InputPickerProps.onSelect`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`InputPickerProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`InputPickerProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`InputPickerProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`InputPickerProps.plaintext`

***

### preload?[​](#preload "Direct link to preload?")

> `optional` **preload**: `boolean`

Flag, if true, the data will be loaded in advance, before opening the dropdown, false otherwise.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`LoadDataProps.preload`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`InputPickerProps.preventOverflow`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`InputPickerProps.readOnly`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-14 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`InputPickerProps.renderExtraFooter`

***

### renderMenu()?[​](#rendermenu "Direct link to renderMenu()?")

> `optional` **renderMenu**: (`menu`) => `ReactNode`

Customizing the Rendering Menu list

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### menu[​](#menu "Direct link to menu")

`ReactNode`

#### Returns[​](#returns-15 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`InputPickerProps.renderMenu`

***

### renderMenuGroup()?[​](#rendermenugroup "Direct link to renderMenuGroup()?")

> `optional` **renderMenuGroup**: (`title`, `item`) => `ReactNode`

Custom render menu group

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### title[​](#title "Direct link to title")

`ReactNode`

##### item[​](#item-2 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-16 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`InputPickerProps.renderMenuGroup`

***

### renderMenuItem()?[​](#rendermenuitem "Direct link to renderMenuItem()?")

> `optional` **renderMenuItem**: (`label`, `item`) => `ReactNode`

Custom render menuItems

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### label[​](#label-1 "Direct link to label")

`ReactNode`

##### item[​](#item-3 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-17 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`InputPickerProps.renderMenuItem`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`, `item`, `selectedElement`) => `ReactNode`

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

`any`

##### item[​](#item-4 "Direct link to item")

`ItemDataType`<`any`>

##### selectedElement[​](#selectedelement "Direct link to selectedElement")

`ReactNode`

#### Returns[​](#returns-18 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`InputPickerProps.renderValue`

***

### searchable?[​](#searchable "Direct link to searchable?")

> `optional` **searchable**: `boolean`

Whether dispaly search input box

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`InputPickerProps.searchable`

***

### searchBy()?[​](#searchby "Direct link to searchBy()?")

> `optional` **searchBy**: (`keyword`, `label`, `item`) => `boolean`

Custom search rules.

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### keyword[​](#keyword "Direct link to keyword")

`string`

##### label[​](#label-2 "Direct link to label")

`ReactNode`

##### item[​](#item-5 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-19 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`InputPickerProps.searchBy`

***

### shouldDisplayCreateOption()?[​](#shoulddisplaycreateoption "Direct link to shouldDisplayCreateOption()?")

> `optional` **shouldDisplayCreateOption**: (`searchKeyword`, `filteredData`) => `boolean`

Customize whether to display "Create option" action with given textbox value

By default, InputPicker hides "Create option" action when textbox value matches any filtered item's \[valueKey] property

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword-1 "Direct link to searchKeyword")

`string`

Value of the textbox

##### filteredData[​](#filtereddata "Direct link to filteredData")

`InputItemDataType`<`any`>\[]

The items filtered by the searchKeyword

#### Returns[​](#returns-20 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`InputPickerProps.shouldDisplayCreateOption`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`InputPickerProps.size`

***

### sort()?[​](#sort "Direct link to sort()?")

> `optional` **sort**: (`isGroup`) => (`a`, `b`) => `number`

Sort options

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### isGroup[​](#isgroup "Direct link to isGroup")

`boolean`

#### Returns[​](#returns-21 "Direct link to Returns")

> (`a`, `b`): `number`

##### Parameters[​](#parameters-19 "Direct link to Parameters")

###### a[​](#a "Direct link to a")

`any`

###### b[​](#b "Direct link to b")

`any`

##### Returns[​](#returns-22 "Direct link to Returns")

`number`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`InputPickerProps.sort`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`InputPickerProps.style`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`InputPickerProps.tabIndex`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`InputPickerProps.toggleAs`

***

### value?[​](#value-4 "Direct link to value?")

> `optional` **value**: `any`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`InputPickerProps.value`

***

### valueKey?[​](#valuekey "Direct link to valueKey?")

> `optional` **valueKey**: `string`

The key to use for setting the option value in the data.

#### Default[​](#default-2 "Direct link to Default")

```
value
```

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`InputPickerProps.valueKey`

***

### virtualized?[​](#virtualized "Direct link to virtualized?")

> `optional` **virtualized**: `boolean`

Whether using virtualized list

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`InputPickerProps.virtualized`


---

# Interface: RsErrorMessageProps

The properties of RsErrorMessage component.

## Extends[​](#extends "Direct link to Extends")

* [`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps)

## Properties[​](#properties "Direct link to Properties")

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

The wrapped component.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps).[`children`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps#children)

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

The CSS class name.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps).[`className`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps#classname)

***

### error?[​](#error "Direct link to error?")

> `optional` **error**: `string`

The error text.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

[`ErrorWrapperProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps).[`error`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps#error)

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement8`

The placement of an error message.


---

# Interface: RsHeaderProps

Props for the RsHeader component.

## Extends[​](#extends "Direct link to Extends")

* `TextProps`

## Properties[​](#properties "Direct link to Properties")

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `string`

The text alignment.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`TextProps.alignment`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`TextProps.backgroundColor`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

The color.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TextProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

The content of the header.

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `number`

The font size.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`TextProps.fontSize`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `string`

The font weight.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`TextProps.fontWeight`

***

### headerSize[​](#headersize "Direct link to headerSize")

> **headerSize**: `string`

The size of the header.


---

# Interface: RsImageProps

Props for the RsImage component.

## Extends[​](#extends "Direct link to Extends")

* `ComponentProps`<`"img"`>.`AreaProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ComponentProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ComponentProps.accessKey`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ComponentProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ComponentProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ComponentProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ComponentProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ComponentProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ComponentProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ComponentProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ComponentProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ComponentProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ComponentProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ComponentProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ComponentProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ComponentProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ComponentProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ComponentProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ComponentProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ComponentProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ComponentProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ComponentProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ComponentProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ComponentProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ComponentProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ComponentProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ComponentProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ComponentProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ComponentProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ComponentProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ComponentProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ComponentProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ComponentProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ComponentProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ComponentProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ComponentProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ComponentProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ComponentProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ComponentProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ComponentProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ComponentProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ComponentProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ComponentProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`ComponentProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`ComponentProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`ComponentProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`ComponentProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`ComponentProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`ComponentProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`ComponentProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`ComponentProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`ComponentProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`ComponentProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`ComponentProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`ComponentProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`ComponentProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`ComponentProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`ComponentProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`ComponentProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`ComponentProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`ComponentProps.autoSave`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`AreaProps.backgroundColor`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactI18NextChild` | `Iterable`<`ReactI18NextChild`, `any`, `any`>

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`ComponentProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`ComponentProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`ComponentProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`ComponentProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`ComponentProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`ComponentProps.contextMenu`

***

### crossOrigin?[​](#crossorigin "Direct link to crossOrigin?")

> `optional` **crossOrigin**: `CrossOrigin`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`ComponentProps.crossOrigin`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`ComponentProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`ComponentProps.datatype`

***

### decoding?[​](#decoding "Direct link to decoding?")

> `optional` **decoding**: `"async"` | `"auto"` | `"sync"`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`ComponentProps.decoding`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`ComponentProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`ComponentProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`ComponentProps.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`ComponentProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`ComponentProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`ComponentProps.exportparts`

***

### fetchPriority?[​](#fetchpriority "Direct link to fetchPriority?")

> `optional` **fetchPriority**: `"auto"` | `"high"` | `"low"`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`ComponentProps.fetchPriority`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`ComponentProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`ComponentProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`ComponentProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`ComponentProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`ComponentProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`ComponentProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`ComponentProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`ComponentProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`ComponentProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`ComponentProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`ComponentProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`ComponentProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`ComponentProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`ComponentProps.lang`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `"lazy"` | `"eager"`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`ComponentProps.loading`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`ComponentProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`ComponentProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`ComponentProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`ComponentProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`ComponentProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`ComponentProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`ComponentProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`ComponentProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`ComponentProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`ComponentProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`ComponentProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`ComponentProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`ComponentProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`ComponentProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`ComponentProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`ComponentProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`ComponentProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`ComponentProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`ComponentProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`ComponentProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`ComponentProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`ComponentProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`ComponentProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`ComponentProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`ComponentProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`ComponentProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`ComponentProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`ComponentProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`ComponentProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`ComponentProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`ComponentProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`ComponentProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`ComponentProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`ComponentProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`ComponentProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`ComponentProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`ComponentProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`ComponentProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`ComponentProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`ComponentProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`ComponentProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`ComponentProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`ComponentProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`ComponentProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`ComponentProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`ComponentProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`ComponentProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`ComponentProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`ComponentProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`ComponentProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`ComponentProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`ComponentProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`ComponentProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`ComponentProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`ComponentProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`ComponentProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`ComponentProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`ComponentProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`ComponentProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`ComponentProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`ComponentProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`ComponentProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`ComponentProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`ComponentProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`ComponentProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`ComponentProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`ComponentProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`ComponentProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`ComponentProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`ComponentProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`ComponentProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`ComponentProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`ComponentProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`ComponentProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`ComponentProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`ComponentProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`ComponentProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`ComponentProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`ComponentProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`ComponentProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`ComponentProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`ComponentProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`ComponentProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`ComponentProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`ComponentProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`ComponentProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`ComponentProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`ComponentProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`ComponentProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`ComponentProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`ComponentProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`ComponentProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`ComponentProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`ComponentProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`ComponentProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`ComponentProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`ComponentProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`ComponentProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`ComponentProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`ComponentProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`ComponentProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`ComponentProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`ComponentProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`ComponentProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`ComponentProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`ComponentProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`ComponentProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`ComponentProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`ComponentProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`ComponentProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`ComponentProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`ComponentProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`ComponentProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`ComponentProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`ComponentProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`ComponentProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`ComponentProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`ComponentProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`ComponentProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`ComponentProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`ComponentProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`ComponentProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`ComponentProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`ComponentProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`ComponentProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`ComponentProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`ComponentProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`ComponentProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`ComponentProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`ComponentProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`ComponentProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`ComponentProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`ComponentProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`ComponentProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`ComponentProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`ComponentProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`ComponentProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`ComponentProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`ComponentProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`ComponentProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`ComponentProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`ComponentProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`ComponentProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`ComponentProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`ComponentProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`ComponentProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`ComponentProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`ComponentProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`ComponentProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`ComponentProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`ComponentProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`ComponentProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`ComponentProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`ComponentProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`ComponentProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`ComponentProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`ComponentProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`ComponentProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`ComponentProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`ComponentProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`ComponentProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`ComponentProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`ComponentProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`ComponentProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLImageElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`ComponentProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`ComponentProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`ComponentProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`ComponentProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`ComponentProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`ComponentProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ComponentProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`ComponentProps.radioGroup`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLImageElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`ComponentProps.ref`

***

### referrerPolicy?[​](#referrerpolicy "Direct link to referrerPolicy?")

> `optional` **referrerPolicy**: `HTMLAttributeReferrerPolicy`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ComponentProps.referrerPolicy`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`ComponentProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`ComponentProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`ComponentProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`ComponentProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`ComponentProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`ComponentProps.security`

***

### sizes?[​](#sizes "Direct link to sizes?")

> `optional` **sizes**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`ComponentProps.sizes`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`ComponentProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`ComponentProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`ComponentProps.src`

***

### srcSet?[​](#srcset "Direct link to srcSet?")

> `optional` **srcSet**: `string`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`ComponentProps.srcSet`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`ComponentProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`ComponentProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`ComponentProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`ComponentProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`ComponentProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`ComponentProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`ComponentProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`ComponentProps.unselectable`

***

### useMap?[​](#usemap "Direct link to useMap?")

> `optional` **useMap**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`ComponentProps.useMap`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`ComponentProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`ComponentProps.width`


---

# Interface: RsInputProps

Props for the RsInput component.

## Extends[​](#extends "Direct link to Extends")

* `InputProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`InputProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`InputProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`InputProps.accessKey`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`InputProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`InputProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`InputProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`InputProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`InputProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`InputProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`InputProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`InputProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`InputProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`InputProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`InputProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`InputProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`InputProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`InputProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`InputProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`InputProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`InputProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`InputProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`InputProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`InputProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`InputProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`InputProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`InputProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`InputProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`InputProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`InputProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`InputProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`InputProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`InputProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`InputProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`InputProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`InputProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`InputProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`InputProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`InputProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`InputProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`InputProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`InputProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`InputProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`InputProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`InputProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`InputProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`InputProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`InputProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`InputProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`InputProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`InputProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`InputProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`InputProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`InputProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`InputProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`InputProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`InputProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`InputProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`InputProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`InputProps.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `HTMLInputAutoCompleteAttribute`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`InputProps.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`InputProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`InputProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`InputProps.autoSave`

***

### capture?[​](#capture "Direct link to capture?")

> `optional` **capture**: `boolean` | `"environment"` | `"user"`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`InputProps.capture`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`InputProps.checked`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`InputProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`InputProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`InputProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`InputProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`InputProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`InputProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`InputProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`InputProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`InputProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`InputProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`InputProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`InputProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`InputProps.disabled`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`InputProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`InputProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`InputProps.exportparts`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`InputProps.form`

***

### formAction?[​](#formaction "Direct link to formAction?")

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`InputProps.formAction`

***

### formEncType?[​](#formenctype "Direct link to formEncType?")

> `optional` **formEncType**: `string`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`InputProps.formEncType`

***

### formMethod?[​](#formmethod "Direct link to formMethod?")

> `optional` **formMethod**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`InputProps.formMethod`

***

### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?")

> `optional` **formNoValidate**: `boolean`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`InputProps.formNoValidate`

***

### formTarget?[​](#formtarget "Direct link to formTarget?")

> `optional` **formTarget**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`InputProps.formTarget`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`InputProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`InputProps.hidden`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

#### Overrides[​](#overrides "Direct link to Overrides")

`InputProps.htmlSize`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The HTML input id

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`InputProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`InputProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`InputProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`InputProps.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Ref of input element

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`InputProps.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`InputProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`InputProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`InputProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`InputProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`InputProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`InputProps.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the input.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`InputProps.lang`

***

### list?[​](#list "Direct link to list?")

> `optional` **list**: `string`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`InputProps.list`

***

### max?[​](#max "Direct link to max?")

> `optional` **max**: `string` | `number`

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`InputProps.max`

***

### maxLength?[​](#maxlength "Direct link to maxLength?")

> `optional` **maxLength**: `number`

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`InputProps.maxLength`

***

### min?[​](#min "Direct link to min?")

> `optional` **min**: `string` | `number`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`InputProps.min`

***

### minLength?[​](#minlength "Direct link to minLength?")

> `optional` **minLength**: `number`

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`InputProps.minLength`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`InputProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`InputProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`InputProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`InputProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`InputProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`InputProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`InputProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`InputProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`InputProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`InputProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`InputProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`InputProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`InputProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`InputProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`InputProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`InputProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`InputProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`InputProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`InputProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`InputProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`InputProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`InputProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `PrependParameters`<`ChangeEventHandler`<`HTMLInputElement`>, \[`string`]>

The callback function in which value is changed.

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`InputProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`InputProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`InputProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`InputProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`InputProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`InputProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`InputProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`InputProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`InputProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`InputProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`InputProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`InputProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`InputProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`InputProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`InputProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`InputProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`InputProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`InputProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`InputProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`InputProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`InputProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`InputProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`InputProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`InputProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`InputProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`InputProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`InputProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`InputProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`InputProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`InputProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`InputProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`InputProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`InputProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`InputProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`InputProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`InputProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`InputProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`InputProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`InputProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`InputProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`InputProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`InputProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`InputProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`InputProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`InputProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`InputProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`InputProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`InputProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`InputProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`InputProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`InputProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`InputProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`InputProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`InputProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`InputProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`InputProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`InputProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`InputProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`InputProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`InputProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`InputProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`InputProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`InputProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`InputProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`InputProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`InputProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`InputProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`InputProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`InputProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`InputProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`InputProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`InputProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`InputProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`InputProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`InputProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`InputProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`InputProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`InputProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`InputProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`InputProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`InputProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`InputProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`InputProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`InputProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`InputProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`InputProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`InputProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`InputProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`InputProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`InputProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`InputProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`InputProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`InputProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`InputProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`InputProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`InputProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`InputProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`InputProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`InputProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`InputProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`InputProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`InputProps.onPointerUpCapture`

***

### onPressEnter?[​](#onpressenter "Direct link to onPressEnter?")

> `optional` **onPressEnter**: `KeyboardEventHandler`<`HTMLInputElement`>

Called on press enter

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`InputProps.onPressEnter`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`InputProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`InputProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`InputProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`InputProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`InputProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`InputProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`InputProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`InputProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`InputProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`InputProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`InputProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`InputProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`InputProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`InputProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`InputProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`InputProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`InputProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`InputProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`InputProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`InputProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`InputProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`InputProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`InputProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`InputProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`InputProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`InputProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`InputProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`InputProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`InputProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`InputProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`InputProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`InputProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`InputProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`InputProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`InputProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`InputProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`InputProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`InputProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`InputProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`InputProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`InputProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`InputProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`InputProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`InputProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`InputProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`InputProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`InputProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`InputProps.part`

***

### passwordMask?[​](#passwordmask "Direct link to passwordMask?")

> `optional` **passwordMask**: `boolean`

Whether to show password mask.

***

### pattern?[​](#pattern "Direct link to pattern?")

> `optional` **pattern**: `string`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`InputProps.pattern`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`InputProps.placeholder`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`InputProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`InputProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`InputProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`InputProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`InputProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`InputProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`InputProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`InputProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`InputProps.rel`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`InputProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`InputProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`InputProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`InputProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`InputProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`InputProps.security`

***

### showPasswordAriaLabel[​](#showpasswordarialabel "Direct link to showPasswordAriaLabel")

> **showPasswordAriaLabel**: `string`

The aria label for the show password button.

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`InputProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`InputProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`InputProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`InputProps.src`

***

### step?[​](#step "Direct link to step?")

> `optional` **step**: `string` | `number`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`InputProps.step`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`InputProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`InputProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`InputProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`InputProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`InputProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`InputProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `"number"` | `"search"` | `"time"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"password"`

The type of the input.

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`InputProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`InputProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`InputProps.unselectable`

***

### value?[​](#value "Direct link to value?")

> `optional` **value**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`InputProps.value`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`InputProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`InputProps.width`


---

# Interface: RsLabelProps

Props for the RsLabel component.

## Extends[​](#extends "Direct link to Extends")

* `TextProps`

## Properties[​](#properties "Direct link to Properties")

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `string`

The text alignment.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`TextProps.alignment`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`TextProps.backgroundColor`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

The color.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TextProps.color`

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `number`

The font size.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`TextProps.fontSize`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `string`

The font weight.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`TextProps.fontWeight`

***

### text[​](#text "Direct link to text")

> **text**: `string`

The label text content.


---

# Interface: RsLinkProps

Props for the RsLink component.

## Extends[​](#extends "Direct link to Extends")

* `ComponentProps`<`"a"`>.`TextProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ComponentProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ComponentProps.accessKey`

***

### alignment?[​](#alignment "Direct link to alignment?")

> `optional` **alignment**: `string`

The text alignment.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TextProps.alignment`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ComponentProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ComponentProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ComponentProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ComponentProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ComponentProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ComponentProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ComponentProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ComponentProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ComponentProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ComponentProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ComponentProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ComponentProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ComponentProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ComponentProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ComponentProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ComponentProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ComponentProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ComponentProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ComponentProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ComponentProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ComponentProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ComponentProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ComponentProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ComponentProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ComponentProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ComponentProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ComponentProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ComponentProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ComponentProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ComponentProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ComponentProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ComponentProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ComponentProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ComponentProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ComponentProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ComponentProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ComponentProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ComponentProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ComponentProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`ComponentProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`ComponentProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`ComponentProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`ComponentProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`ComponentProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`ComponentProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`ComponentProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`ComponentProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`ComponentProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`ComponentProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`ComponentProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`ComponentProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`ComponentProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`ComponentProps.aria-valuetext`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`ComponentProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`ComponentProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`ComponentProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`ComponentProps.autoSave`

***

### backgroundColor?[​](#backgroundcolor "Direct link to backgroundColor?")

> `optional` **backgroundColor**: `string`

The background color.

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`TextProps.backgroundColor`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactI18NextChild` | `Iterable`<`ReactI18NextChild`, `any`, `any`>

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`ComponentProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`ComponentProps.className`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`ComponentProps.color`

***

### content[​](#content "Direct link to content")

> **content**: `string`

The content type (text or custom).

#### Overrides[​](#overrides "Direct link to Overrides")

`ComponentProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`ComponentProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`ComponentProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`ComponentProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`ComponentProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`ComponentProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`ComponentProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`ComponentProps.dir`

***

### download?[​](#download "Direct link to download?")

> `optional` **download**: `any`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`ComponentProps.download`

***

### downloadFilename[​](#downloadfilename "Direct link to downloadFilename")

> **downloadFilename**: `string`

The filename for download when download is enabled.

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`ComponentProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`ComponentProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`ComponentProps.exportparts`

***

### fontSize?[​](#fontsize "Direct link to fontSize?")

> `optional` **fontSize**: `number`

The font size.

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`TextProps.fontSize`

***

### fontWeight?[​](#fontweight "Direct link to fontWeight?")

> `optional` **fontWeight**: `string`

The font weight.

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`TextProps.fontWeight`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`ComponentProps.hidden`

***

### href?[​](#href "Direct link to href?")

> `optional` **href**: `string`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`ComponentProps.href`

***

### hrefLang?[​](#hreflang "Direct link to hrefLang?")

> `optional` **hrefLang**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`ComponentProps.hrefLang`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`ComponentProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`ComponentProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`ComponentProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`ComponentProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`ComponentProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`ComponentProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`ComponentProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`ComponentProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`ComponentProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`ComponentProps.itemType`

***

### key?[​](#key "Direct link to key?")

> `optional` **key**: `null` | `Key`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`ComponentProps.key`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`ComponentProps.lang`

***

### media?[​](#media "Direct link to media?")

> `optional` **media**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`ComponentProps.media`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`ComponentProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`ComponentProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`ComponentProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`ComponentProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`ComponentProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`ComponentProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`ComponentProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`ComponentProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`ComponentProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`ComponentProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`ComponentProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`ComponentProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`ComponentProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`ComponentProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`ComponentProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`ComponentProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`ComponentProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`ComponentProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`ComponentProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`ComponentProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`ComponentProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`ComponentProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`ComponentProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`ComponentProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`ComponentProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`ComponentProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`ComponentProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`ComponentProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`ComponentProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`ComponentProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`ComponentProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`ComponentProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`ComponentProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`ComponentProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`ComponentProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`ComponentProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`ComponentProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`ComponentProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`ComponentProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`ComponentProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`ComponentProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`ComponentProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`ComponentProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`ComponentProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`ComponentProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`ComponentProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`ComponentProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`ComponentProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`ComponentProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`ComponentProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`ComponentProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`ComponentProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`ComponentProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`ComponentProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`ComponentProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`ComponentProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`ComponentProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`ComponentProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`ComponentProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`ComponentProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`ComponentProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`ComponentProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`ComponentProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`ComponentProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`ComponentProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`ComponentProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`ComponentProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`ComponentProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`ComponentProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`ComponentProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`ComponentProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`ComponentProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`ComponentProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`ComponentProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`ComponentProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`ComponentProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`ComponentProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`ComponentProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`ComponentProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`ComponentProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`ComponentProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`ComponentProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`ComponentProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`ComponentProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`ComponentProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`ComponentProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`ComponentProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`ComponentProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`ComponentProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`ComponentProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`ComponentProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`ComponentProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`ComponentProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`ComponentProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`ComponentProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`ComponentProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`ComponentProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`ComponentProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`ComponentProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`ComponentProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`ComponentProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`ComponentProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`ComponentProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`ComponentProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`ComponentProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`ComponentProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`ComponentProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`ComponentProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`ComponentProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`ComponentProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`ComponentProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`ComponentProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`ComponentProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`ComponentProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`ComponentProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`ComponentProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`ComponentProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`ComponentProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`ComponentProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`ComponentProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`ComponentProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`ComponentProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`ComponentProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`ComponentProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`ComponentProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`ComponentProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`ComponentProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`ComponentProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`ComponentProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`ComponentProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`ComponentProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`ComponentProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`ComponentProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`ComponentProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`ComponentProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`ComponentProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`ComponentProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`ComponentProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`ComponentProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`ComponentProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`ComponentProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`ComponentProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`ComponentProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`ComponentProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`ComponentProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`ComponentProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`ComponentProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`ComponentProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`ComponentProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`ComponentProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`ComponentProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`ComponentProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`ComponentProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`ComponentProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`ComponentProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`ComponentProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`ComponentProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`ComponentProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`ComponentProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`ComponentProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`ComponentProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`ComponentProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`ComponentProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`ComponentProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`ComponentProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`ComponentProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLAnchorElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`ComponentProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`ComponentProps.part`

***

### ping?[​](#ping "Direct link to ping?")

> `optional` **ping**: `string`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`ComponentProps.ping`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`ComponentProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`ComponentProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`ComponentProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`ComponentProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`ComponentProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`ComponentProps.radioGroup`

***

### ref?[​](#ref "Direct link to ref?")

> `optional` **ref**: `Ref`<`HTMLAnchorElement`>

Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).

#### See[​](#see-34 "Direct link to See")

[React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom)

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`ComponentProps.ref`

***

### referrerPolicy?[​](#referrerpolicy "Direct link to referrerPolicy?")

> `optional` **referrerPolicy**: `HTMLAttributeReferrerPolicy`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`ComponentProps.referrerPolicy`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`ComponentProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`ComponentProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`ComponentProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`ComponentProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`ComponentProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`ComponentProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`ComponentProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`ComponentProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`ComponentProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`ComponentProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`ComponentProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`ComponentProps.tabIndex`

***

### target?[​](#target "Direct link to target?")

> `optional` **target**: `HTMLAttributeAnchorTarget`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`ComponentProps.target`

***

### text[​](#text "Direct link to text")

> **text**: `string`

The link text content.

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`ComponentProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`ComponentProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`ComponentProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`ComponentProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`ComponentProps.unselectable`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`ComponentProps.vocab`


---

# Interface: RsMenuProps

Props for the RsMenu component.

## Extends[​](#extends "Direct link to Extends")

* `NavProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`NavProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`NavProps.accessKey`

***

### activeKey?[​](#activekey "Direct link to activeKey?")

> `optional` **activeKey**: `any`

The active key of the Nav component.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`NavProps.activeKey`

***

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `"default"` | `"tabs"` | `"subtle"` | `"pills"`

The appearance style of the Nav component.

#### Default[​](#default "Direct link to Default")

```
'default'
```

#### Version[​](#version "Direct link to Version")

'pills' is supported in version 5.68.0

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`NavProps.appearance`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`NavProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`NavProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`NavProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`NavProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`NavProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`NavProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`NavProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`NavProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`NavProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`NavProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`NavProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`NavProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`NavProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`NavProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`NavProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`NavProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`NavProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`NavProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`NavProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`NavProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`NavProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`NavProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`NavProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`NavProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`NavProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`NavProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`NavProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`NavProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`NavProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`NavProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`NavProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`NavProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`NavProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`NavProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`NavProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`NavProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`NavProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`NavProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`NavProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`NavProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`NavProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`NavProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`NavProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`NavProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`NavProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`NavProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`NavProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`NavProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`NavProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`NavProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`NavProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`NavProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`NavProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`NavProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`NavProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`NavProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`NavProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`NavProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`NavProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`NavProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`NavProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`NavProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`NavProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`NavProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`NavProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`NavProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`NavProps.datatype`

***

### defaultActiveKey?[​](#defaultactivekey "Direct link to defaultActiveKey?")

> `optional` **defaultActiveKey**: `any`

The default active key of the Nav component.

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`NavProps.defaultActiveKey`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`NavProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`NavProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`NavProps.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`NavProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`NavProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`NavProps.exportparts`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`NavProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`NavProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`NavProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`NavProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`NavProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`NavProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`NavProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`NavProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`NavProps.itemRef`

***

### items?[​](#items "Direct link to items?")

> `optional` **items**: [`MenuItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/MenuItem)\[]

The items for the menu.

***

### itemsAs[​](#itemsas "Direct link to itemsAs")

> **itemsAs**: `ElementType`

The element type for menu items.

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`NavProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`NavProps.itemType`

***

### justified?[​](#justified "Direct link to justified?")

> `optional` **justified**: `boolean`

Whether the Nav component is justified.

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`NavProps.justified`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`NavProps.lang`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`NavProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`NavProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`NavProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`NavProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`NavProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`NavProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`NavProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`NavProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`NavProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`NavProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`NavProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`NavProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`NavProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`NavProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`NavProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`NavProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`NavProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`NavProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`NavProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`NavProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`NavProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`NavProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`NavProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`NavProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`NavProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`NavProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`NavProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`NavProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`NavProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`NavProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`NavProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`NavProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`NavProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`NavProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`NavProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`NavProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`NavProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`NavProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`NavProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`NavProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`NavProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`NavProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`NavProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`NavProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`NavProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`NavProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`NavProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`NavProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`NavProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`NavProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`NavProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`NavProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`NavProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`NavProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`NavProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`NavProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`NavProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`NavProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`NavProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`NavProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`NavProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`NavProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`NavProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`NavProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`NavProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`NavProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`NavProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`NavProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`NavProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`NavProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`NavProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`NavProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`NavProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`NavProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`NavProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`NavProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`NavProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`NavProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`NavProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`NavProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`NavProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`NavProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`NavProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`NavProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`NavProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`NavProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`NavProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`NavProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`NavProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`NavProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`NavProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`NavProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`NavProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`NavProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`NavProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`NavProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`NavProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`NavProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`NavProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`NavProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`NavProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`NavProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`NavProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`NavProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`NavProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`NavProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`NavProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`NavProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`NavProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`NavProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`NavProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`NavProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`NavProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`NavProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`NavProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`NavProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`NavProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`NavProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`NavProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`NavProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`NavProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`NavProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`NavProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`NavProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`NavProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`NavProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`NavProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`NavProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`NavProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`NavProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`NavProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`NavProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`NavProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`NavProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`NavProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`NavProps.onSeekingCapture`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`eventKey`, `event`) => `void`

Event handler for selecting a Nav item.

#### Parameters[​](#parameters "Direct link to Parameters")

##### eventKey[​](#eventkey "Direct link to eventKey")

`any`

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`NavProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`NavProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`NavProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`NavProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`NavProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`NavProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`NavProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`NavProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`NavProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`NavProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`NavProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`NavProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`NavProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`NavProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`NavProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`NavProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`NavProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`NavProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`NavProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`NavProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`NavProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`NavProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`NavProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`NavProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`NavProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`NavProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`NavProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`NavProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`NavProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`NavProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`NavProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`NavProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`NavProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`NavProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`NavProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`NavProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`NavProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`NavProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`NavProps.property`

***

### pullRight?[​](#pullright "Direct link to pullRight?")

> `optional` **pullRight**: `boolean`

Whether the Nav component is pulled to the right.

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`NavProps.pullRight`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`NavProps.radioGroup`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`NavProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`NavProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`NavProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`NavProps.rev`

***

### reversed?[​](#reversed "Direct link to reversed?")

> `optional` **reversed**: `boolean`

Whether the Nav component is reversed.

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`NavProps.reversed`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`NavProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`NavProps.security`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`NavProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`NavProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`NavProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`NavProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`NavProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`NavProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`NavProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`NavProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`NavProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`NavProps.unselectable`

***

### vertical?[​](#vertical "Direct link to vertical?")

> `optional` **vertical**: `boolean`

Whether the Nav component is vertical.

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`NavProps.vertical`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`NavProps.vocab`


---

# Interface: RsModalLayoutProps

Props for the RsModalLayout component.

## Properties[​](#properties "Direct link to Properties")

### body[​](#body "Direct link to body")

> **body**: `ReactNode`

The content for the modal body.

***

### closeButton[​](#closebutton "Direct link to closeButton")

> **closeButton**: `boolean`

Whether to show the close button.

***

### footer[​](#footer "Direct link to footer")

> **footer**: `ReactNode`

The content for the modal footer.

***

### headerTitle[​](#headertitle "Direct link to headerTitle")

> **headerTitle**: `ReactNode`

The title for the modal header.


---

# Interface: RsModalProps

Props for the RsModal component.

## Extends[​](#extends "Direct link to Extends")

* `ModalProps`

## Properties[​](#properties "Direct link to Properties")

### animation?[​](#animation "Direct link to animation?")

> `optional` **animation**: `ElementType`<`any`, keyof IntrinsicElements>

Set an animation effect for Modal, the default is Bounce.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`ModalProps.animation`

***

### animationProps?[​](#animationprops "Direct link to animationProps?")

> `optional` **animationProps**: `any`

Animation-related properties

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`ModalProps.animationProps`

***

### animationTimeout?[​](#animationtimeout "Direct link to animationTimeout?")

> `optional` **animationTimeout**: `number`

Set the duration of the animation

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`ModalProps.animationTimeout`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`ModalProps.aria-describedby`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-1 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`ModalProps.aria-labelledby`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`ModalProps.as`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

When set to true, the Modal is opened and is automatically focused on its own, accessible to screen readers

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`ModalProps.autoFocus`

***

### backdrop?[​](#backdrop "Direct link to backdrop?")

> `optional` **backdrop**: `boolean` | `"static"`

When set to true, the Modal will display the background when it is opened. Clicking on the background will close the Modal. If you do not want to close the Modal, set it to 'static'.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`ModalProps.backdrop`

***

### backdropClassName?[​](#backdropclassname "Direct link to backdropClassName?")

> `optional` **backdropClassName**: `string`

Add an optional extra class name to .modal-backdrop It could end up looking like class="modal-backdrop foo-modal-backdrop in"

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`ModalProps.backdropClassName`

***

### backdropStyle?[​](#backdropstyle "Direct link to backdropStyle?")

> `optional` **backdropStyle**: `CSSProperties`

CSS style applied to backdrop DOM nodes

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`ModalProps.backdropStyle`

***

### backdropTransitionTimeout?[​](#backdroptransitiontimeout "Direct link to backdropTransitionTimeout?")

> `optional` **backdropTransitionTimeout**: `number`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`ModalProps.backdropTransitionTimeout`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`ModalProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`ModalProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`ModalProps.classPrefix`

***

### closeButton?[​](#closebutton "Direct link to closeButton?")

> `optional` **closeButton**: `ReactNode`

Custom close button, used when rendered as a Drawer

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`ModalProps.closeButton`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`ModalProps.container`

***

### containerClassName?[​](#containerclassname "Direct link to containerClassName?")

> `optional` **containerClassName**: `string`

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`ModalProps.containerClassName`

***

### dialogAs?[​](#dialogas "Direct link to dialogAs?")

> `optional` **dialogAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element type for Dialog

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`ModalProps.dialogAs`

***

### dialogClassName?[​](#dialogclassname "Direct link to dialogClassName?")

> `optional` **dialogClassName**: `string`

CSS class applied to Dialog DOM nodes

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`ModalProps.dialogClassName`

***

### dialogStyle?[​](#dialogstyle "Direct link to dialogStyle?")

> `optional` **dialogStyle**: `CSSProperties`

CSS style applied to dialog DOM nodes

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`ModalProps.dialogStyle`

***

### dialogTransitionTimeout?[​](#dialogtransitiontimeout "Direct link to dialogTransitionTimeout?")

> `optional` **dialogTransitionTimeout**: `number`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`ModalProps.dialogTransitionTimeout`

***

### enforceFocus?[​](#enforcefocus "Direct link to enforceFocus?")

> `optional` **enforceFocus**: `boolean`

When set to true, Modal will prevent the focus from leaving when opened, making it easier for the secondary screen reader to access

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`ModalProps.enforceFocus`

***

### ~~full?~~[​](#full "Direct link to full")

> `optional` **full**: `boolean`

Full screen

#### Deprecated[​](#deprecated "Direct link to Deprecated")

Use size="full" instead.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`ModalProps.full`

***

### handleClose()?[​](#handleclose "Direct link to handleClose()?")

> `optional` **handleClose**: () => `void`

Custom close handler function.

#### Returns[​](#returns "Direct link to Returns")

`void`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`ModalProps.id`

***

### isDrawer?[​](#isdrawer "Direct link to isDrawer?")

> `optional` **isDrawer**: `boolean`

Indicates if the component should be displayed as a drawer

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`ModalProps.isDrawer`

***

### keyboard?[​](#keyboard "Direct link to keyboard?")

> `optional` **keyboard**: `boolean`

Close Modal when esc key is pressed

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`ModalProps.keyboard`

***

### onBackdropClick?[​](#onbackdropclick "Direct link to onBackdropClick?")

> `optional` **onBackdropClick**: `MouseEventHandler`<`Element`>

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`ModalProps.onBackdropClick`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: (`event`) => `void`

Called when Modal is closed

#### Parameters[​](#parameters "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`ModalProps.onClose`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`ModalProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`ModalProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`ModalProps.onEntering`

***

### onEsc?[​](#onesc "Direct link to onEsc?")

> `optional` **onEsc**: `KeyboardEventHandler`<`Element`>

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`ModalProps.onEsc`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`ModalProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`ModalProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`ModalProps.onExiting`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`ModalProps.onOpen`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open modal

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`ModalProps.open`

***

### overflow?[​](#overflow "Direct link to overflow?")

> `optional` **overflow**: `boolean`

Automatically sets the height when the body content is too long.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`ModalProps.overflow`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`ModalProps.role`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `ModalSize`

A modal can have different sizes

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`ModalProps.size`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`ModalProps.style`

***

### transition?[​](#transition "Direct link to transition?")

> `optional` **transition**: `ElementType`<`any`, keyof IntrinsicElements>

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`ModalProps.transition`


---

# Interface: RsNumberFormatProps

Props for the RsNumberFormat component.

## Extends[​](#extends "Direct link to Extends")

* `NumericFormatProps`<`InputProps`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`NumericFormatProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`NumericFormatProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`NumericFormatProps.accessKey`

***

### allowedDecimalSeparators?[​](#alloweddecimalseparators "Direct link to allowedDecimalSeparators?")

> `optional` **allowedDecimalSeparators**: `string`\[]

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`NumericFormatProps.allowedDecimalSeparators`

***

### allowLeadingZeros?[​](#allowleadingzeros "Direct link to allowLeadingZeros?")

> `optional` **allowLeadingZeros**: `boolean`

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`NumericFormatProps.allowLeadingZeros`

***

### allowNegative?[​](#allownegative "Direct link to allowNegative?")

> `optional` **allowNegative**: `boolean`

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`NumericFormatProps.allowNegative`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`NumericFormatProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`NumericFormatProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`NumericFormatProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`NumericFormatProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`NumericFormatProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`NumericFormatProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`NumericFormatProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`NumericFormatProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`NumericFormatProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`NumericFormatProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`NumericFormatProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`NumericFormatProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`NumericFormatProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`NumericFormatProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`NumericFormatProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`NumericFormatProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`NumericFormatProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`NumericFormatProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`NumericFormatProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`NumericFormatProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`NumericFormatProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`NumericFormatProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`NumericFormatProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`NumericFormatProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`NumericFormatProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`NumericFormatProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`NumericFormatProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`NumericFormatProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`NumericFormatProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`NumericFormatProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`NumericFormatProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`NumericFormatProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`NumericFormatProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`NumericFormatProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`NumericFormatProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`NumericFormatProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`NumericFormatProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`NumericFormatProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`NumericFormatProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`NumericFormatProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`NumericFormatProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`NumericFormatProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`NumericFormatProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`NumericFormatProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`NumericFormatProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`NumericFormatProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`NumericFormatProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`NumericFormatProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`NumericFormatProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`NumericFormatProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`NumericFormatProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`NumericFormatProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`NumericFormatProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`NumericFormatProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`NumericFormatProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`NumericFormatProps.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `HTMLInputAutoCompleteAttribute`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`NumericFormatProps.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`NumericFormatProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`NumericFormatProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`NumericFormatProps.autoSave`

***

### capture?[​](#capture "Direct link to capture?")

> `optional` **capture**: `boolean` | `"environment"` | `"user"`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`NumericFormatProps.capture`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`NumericFormatProps.checked`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`NumericFormatProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`NumericFormatProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`NumericFormatProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`NumericFormatProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`NumericFormatProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`NumericFormatProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`NumericFormatProps.contextMenu`

***

### customInput?[​](#custominput "Direct link to customInput?")

> `optional` **customInput**: `ComponentType`<`InputProps`>

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`NumericFormatProps.customInput`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`NumericFormatProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`NumericFormatProps.datatype`

***

### decimalScale?[​](#decimalscale "Direct link to decimalScale?")

> `optional` **decimalScale**: `number`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`NumericFormatProps.decimalScale`

***

### decimalSeparator?[​](#decimalseparator "Direct link to decimalSeparator?")

> `optional` **decimalSeparator**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`NumericFormatProps.decimalSeparator`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`NumericFormatProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`NumericFormatProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`NumericFormatProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`NumericFormatProps.disabled`

***

### displayType?[​](#displaytype "Direct link to displayType?")

> `optional` **displayType**: `"input"` | `"text"`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`NumericFormatProps.displayType`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`NumericFormatProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`NumericFormatProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`NumericFormatProps.exportparts`

***

### fixedDecimalScale?[​](#fixeddecimalscale "Direct link to fixedDecimalScale?")

> `optional` **fixedDecimalScale**: `boolean`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`NumericFormatProps.fixedDecimalScale`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`NumericFormatProps.form`

***

### formAction?[​](#formaction "Direct link to formAction?")

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`>

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`NumericFormatProps.formAction`

***

### formEncType?[​](#formenctype "Direct link to formEncType?")

> `optional` **formEncType**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`NumericFormatProps.formEncType`

***

### formMethod?[​](#formmethod "Direct link to formMethod?")

> `optional` **formMethod**: `string`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`NumericFormatProps.formMethod`

***

### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?")

> `optional` **formNoValidate**: `boolean`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`NumericFormatProps.formNoValidate`

***

### formTarget?[​](#formtarget "Direct link to formTarget?")

> `optional` **formTarget**: `string`

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`NumericFormatProps.formTarget`

***

### getInputRef?[​](#getinputref "Direct link to getInputRef?")

> `optional` **getInputRef**: `Ref`<`any`> | (`el`) => `void`

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`NumericFormatProps.getInputRef`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`NumericFormatProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`NumericFormatProps.hidden`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

#### Overrides[​](#overrides "Direct link to Overrides")

`NumericFormatProps.htmlSize`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The HTML input id

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`NumericFormatProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`NumericFormatProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`NumericFormatProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`NumericFormatProps.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Ref of input element

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`NumericFormatProps.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`NumericFormatProps.is`

***

### isAllowed()?[​](#isallowed "Direct link to isAllowed()?")

> `optional` **isAllowed**: (`values`) => `boolean`

#### Parameters[​](#parameters "Direct link to Parameters")

##### values[​](#values "Direct link to values")

`NumberFormatValues`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`NumericFormatProps.isAllowed`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`NumericFormatProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`NumericFormatProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`NumericFormatProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`NumericFormatProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`NumericFormatProps.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the number input.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`NumericFormatProps.lang`

***

### list?[​](#list "Direct link to list?")

> `optional` **list**: `string`

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`NumericFormatProps.list`

***

### max?[​](#max "Direct link to max?")

> `optional` **max**: `string` | `number`

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`NumericFormatProps.max`

***

### maxLength?[​](#maxlength "Direct link to maxLength?")

> `optional` **maxLength**: `number`

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`NumericFormatProps.maxLength`

***

### min?[​](#min "Direct link to min?")

> `optional` **min**: `string` | `number`

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`NumericFormatProps.min`

***

### minLength?[​](#minlength "Direct link to minLength?")

> `optional` **minLength**: `number`

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`NumericFormatProps.minLength`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`NumericFormatProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`NumericFormatProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`NumericFormatProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`NumericFormatProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`NumericFormatProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`NumericFormatProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`NumericFormatProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`NumericFormatProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`NumericFormatProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`NumericFormatProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`NumericFormatProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`NumericFormatProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`NumericFormatProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`NumericFormatProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`NumericFormatProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`NumericFormatProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`NumericFormatProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`NumericFormatProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`NumericFormatProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`NumericFormatProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`NumericFormatProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`NumericFormatProps.onCanPlayThroughCapture`

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`value`) => `void`

The callback function called when the value changes.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`NumericFormatProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`NumericFormatProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`NumericFormatProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`NumericFormatProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`NumericFormatProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`NumericFormatProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`NumericFormatProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`NumericFormatProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`NumericFormatProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`NumericFormatProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`NumericFormatProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`NumericFormatProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`NumericFormatProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`NumericFormatProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`NumericFormatProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`NumericFormatProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`NumericFormatProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`NumericFormatProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`NumericFormatProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`NumericFormatProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`NumericFormatProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`NumericFormatProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`NumericFormatProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`NumericFormatProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`NumericFormatProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`NumericFormatProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`NumericFormatProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`NumericFormatProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`NumericFormatProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`NumericFormatProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`NumericFormatProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`NumericFormatProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`NumericFormatProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`NumericFormatProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`NumericFormatProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`NumericFormatProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`NumericFormatProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`NumericFormatProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`NumericFormatProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`NumericFormatProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`NumericFormatProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`NumericFormatProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`NumericFormatProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`NumericFormatProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`NumericFormatProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`NumericFormatProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`NumericFormatProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`NumericFormatProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`NumericFormatProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`NumericFormatProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`NumericFormatProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`NumericFormatProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`NumericFormatProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`NumericFormatProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`NumericFormatProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`NumericFormatProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`NumericFormatProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`NumericFormatProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`NumericFormatProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`NumericFormatProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`NumericFormatProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`NumericFormatProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`NumericFormatProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`NumericFormatProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`NumericFormatProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`NumericFormatProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`NumericFormatProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`NumericFormatProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`NumericFormatProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`NumericFormatProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`NumericFormatProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`NumericFormatProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`NumericFormatProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`NumericFormatProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`NumericFormatProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`NumericFormatProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`NumericFormatProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`NumericFormatProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`NumericFormatProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`NumericFormatProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`NumericFormatProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`NumericFormatProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`NumericFormatProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`NumericFormatProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`NumericFormatProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`NumericFormatProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`NumericFormatProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`NumericFormatProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`NumericFormatProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`NumericFormatProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`NumericFormatProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`NumericFormatProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`NumericFormatProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`NumericFormatProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`NumericFormatProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`NumericFormatProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`NumericFormatProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`NumericFormatProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`NumericFormatProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`NumericFormatProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`NumericFormatProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`NumericFormatProps.onPointerUpCapture`

***

### onPressEnter?[​](#onpressenter "Direct link to onPressEnter?")

> `optional` **onPressEnter**: `KeyboardEventHandler`<`HTMLInputElement`>

Called on press enter

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`NumericFormatProps.onPressEnter`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`NumericFormatProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`NumericFormatProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`NumericFormatProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`NumericFormatProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`NumericFormatProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`NumericFormatProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`NumericFormatProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`NumericFormatProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`NumericFormatProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`NumericFormatProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`NumericFormatProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`NumericFormatProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`NumericFormatProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`NumericFormatProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`NumericFormatProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`NumericFormatProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`NumericFormatProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`NumericFormatProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`NumericFormatProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`NumericFormatProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`NumericFormatProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`NumericFormatProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`NumericFormatProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`NumericFormatProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`NumericFormatProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`NumericFormatProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`NumericFormatProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`NumericFormatProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`NumericFormatProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`NumericFormatProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`NumericFormatProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`NumericFormatProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`NumericFormatProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`NumericFormatProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`NumericFormatProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`NumericFormatProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`NumericFormatProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`NumericFormatProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`NumericFormatProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`NumericFormatProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`NumericFormatProps.onTransitionStartCapture`

***

### onValueChange?[​](#onvaluechange "Direct link to onValueChange?")

> `optional` **onValueChange**: `OnValueChange`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`NumericFormatProps.onValueChange`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`NumericFormatProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`NumericFormatProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`NumericFormatProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`NumericFormatProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`NumericFormatProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`NumericFormatProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-32 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`NumericFormatProps.part`

***

### pattern?[​](#pattern "Direct link to pattern?")

> `optional` **pattern**: `string`

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`NumericFormatProps.pattern`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`NumericFormatProps.placeholder`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`NumericFormatProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`NumericFormatProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`NumericFormatProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`NumericFormatProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`NumericFormatProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`NumericFormatProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`NumericFormatProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`NumericFormatProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`NumericFormatProps.rel`

***

### renderText()?[​](#rendertext "Direct link to renderText()?")

> `optional` **renderText**: (`formattedValue`, `otherProps`) => `ReactNode`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### formattedValue[​](#formattedvalue "Direct link to formattedValue")

`string`

##### otherProps[​](#otherprops "Direct link to otherProps")

`Partial`<`NumberFormatBase`>

#### Returns[​](#returns-2 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`NumericFormatProps.renderText`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`NumericFormatProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`NumericFormatProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`NumericFormatProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`NumericFormatProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`NumericFormatProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`NumericFormatProps.security`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`NumericFormatProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`NumericFormatProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`NumericFormatProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`NumericFormatProps.src`

***

### step?[​](#step "Direct link to step?")

> `optional` **step**: `string` | `number`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`NumericFormatProps.step`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`NumericFormatProps.style`

***

### suffix?[​](#suffix "Direct link to suffix?")

> `optional` **suffix**: `string`

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`NumericFormatProps.suffix`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`NumericFormatProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`NumericFormatProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`NumericFormatProps.tabIndex`

***

### thousandSeparator?[​](#thousandseparator "Direct link to thousandSeparator?")

> `optional` **thousandSeparator**: `string` | `boolean`

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`NumericFormatProps.thousandSeparator`

***

### thousandsGroupStyle?[​](#thousandsgroupstyle "Direct link to thousandsGroupStyle?")

> `optional` **thousandsGroupStyle**: `"none"` | `"thousand"` | `"lakh"` | `"wan"`

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`NumericFormatProps.thousandsGroupStyle`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`NumericFormatProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`NumericFormatProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `"text"` | `"tel"` | `"password"`

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`NumericFormatProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-322 "Direct link to Inherited from")

`NumericFormatProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-323 "Direct link to Inherited from")

`NumericFormatProps.unselectable`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-324 "Direct link to Inherited from")

`NumericFormatProps.value`

***

### valueIsNumericString?[​](#valueisnumericstring "Direct link to valueIsNumericString?")

> `optional` **valueIsNumericString**: `boolean`

#### Inherited from[​](#inherited-from-325 "Direct link to Inherited from")

`NumericFormatProps.valueIsNumericString`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-326 "Direct link to Inherited from")

`NumericFormatProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-327 "Direct link to Inherited from")

`NumericFormatProps.width`


---

# Interface: RsPatternFormatProps

Props for the RsPatternFormat component.

## Extends[​](#extends "Direct link to Extends")

* `PatternFormatProps`<`InputProps`>

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`PatternFormatProps.about`

***

### accept?[​](#accept "Direct link to accept?")

> `optional` **accept**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`PatternFormatProps.accept`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`PatternFormatProps.accessKey`

***

### allowEmptyFormatting?[​](#allowemptyformatting "Direct link to allowEmptyFormatting?")

> `optional` **allowEmptyFormatting**: `boolean`

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`PatternFormatProps.allowEmptyFormatting`

***

### alt?[​](#alt "Direct link to alt?")

> `optional` **alt**: `string`

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`PatternFormatProps.alt`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`PatternFormatProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`PatternFormatProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`PatternFormatProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`PatternFormatProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`PatternFormatProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`PatternFormatProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`PatternFormatProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`PatternFormatProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`PatternFormatProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`PatternFormatProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`PatternFormatProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`PatternFormatProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`PatternFormatProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`PatternFormatProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`PatternFormatProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`PatternFormatProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`PatternFormatProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`PatternFormatProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`PatternFormatProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`PatternFormatProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`PatternFormatProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`PatternFormatProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`PatternFormatProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`PatternFormatProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`PatternFormatProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`PatternFormatProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`PatternFormatProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`PatternFormatProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`PatternFormatProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`PatternFormatProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`PatternFormatProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`PatternFormatProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`PatternFormatProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`PatternFormatProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`PatternFormatProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`PatternFormatProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`PatternFormatProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`PatternFormatProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`PatternFormatProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`PatternFormatProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`PatternFormatProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`PatternFormatProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`PatternFormatProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`PatternFormatProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`PatternFormatProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`PatternFormatProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`PatternFormatProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`PatternFormatProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`PatternFormatProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`PatternFormatProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`PatternFormatProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`PatternFormatProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`PatternFormatProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`PatternFormatProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`PatternFormatProps.autoCapitalize`

***

### autoComplete?[​](#autocomplete "Direct link to autoComplete?")

> `optional` **autoComplete**: `HTMLInputAutoCompleteAttribute`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`PatternFormatProps.autoComplete`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`PatternFormatProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`PatternFormatProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`PatternFormatProps.autoSave`

***

### capture?[​](#capture "Direct link to capture?")

> `optional` **capture**: `boolean` | `"environment"` | `"user"`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`PatternFormatProps.capture`

***

### checked?[​](#checked "Direct link to checked?")

> `optional` **checked**: `boolean`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`PatternFormatProps.checked`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`PatternFormatProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`PatternFormatProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`PatternFormatProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`PatternFormatProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`PatternFormatProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`PatternFormatProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`PatternFormatProps.contextMenu`

***

### customInput?[​](#custominput "Direct link to customInput?")

> `optional` **customInput**: `ComponentType`<`InputProps`>

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`PatternFormatProps.customInput`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`PatternFormatProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`PatternFormatProps.datatype`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`PatternFormatProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`PatternFormatProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`PatternFormatProps.dir`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`PatternFormatProps.disabled`

***

### displayType?[​](#displaytype "Direct link to displayType?")

> `optional` **displayType**: `"input"` | `"text"`

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`PatternFormatProps.displayType`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`PatternFormatProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`PatternFormatProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`PatternFormatProps.exportparts`

***

### form?[​](#form "Direct link to form?")

> `optional` **form**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`PatternFormatProps.form`

***

### formAction?[​](#formaction "Direct link to formAction?")

> `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`>

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`PatternFormatProps.formAction`

***

### format[​](#format "Direct link to format")

> **format**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`PatternFormatProps.format`

***

### formEncType?[​](#formenctype "Direct link to formEncType?")

> `optional` **formEncType**: `string`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`PatternFormatProps.formEncType`

***

### formMethod?[​](#formmethod "Direct link to formMethod?")

> `optional` **formMethod**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`PatternFormatProps.formMethod`

***

### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?")

> `optional` **formNoValidate**: `boolean`

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`PatternFormatProps.formNoValidate`

***

### formTarget?[​](#formtarget "Direct link to formTarget?")

> `optional` **formTarget**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`PatternFormatProps.formTarget`

***

### getInputRef?[​](#getinputref "Direct link to getInputRef?")

> `optional` **getInputRef**: `Ref`<`any`> | (`el`) => `void`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`PatternFormatProps.getInputRef`

***

### height?[​](#height "Direct link to height?")

> `optional` **height**: `string` | `number`

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`PatternFormatProps.height`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`PatternFormatProps.hidden`

***

### htmlSize?[​](#htmlsize "Direct link to htmlSize?")

> `optional` **htmlSize**: `number`

The htmlSize attribute defines the width of the «input> element.

#### Overrides[​](#overrides "Direct link to Overrides")

`PatternFormatProps.htmlSize`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

The HTML input id

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`PatternFormatProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`PatternFormatProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`PatternFormatProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`PatternFormatProps.inputMode`

***

### inputRef?[​](#inputref "Direct link to inputRef?")

> `optional` **inputRef**: `Ref`<`any`>

Ref of input element

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`PatternFormatProps.inputRef`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`PatternFormatProps.is`

***

### isAllowed()?[​](#isallowed "Direct link to isAllowed()?")

> `optional` **isAllowed**: (`values`) => `boolean`

#### Parameters[​](#parameters "Direct link to Parameters")

##### values[​](#values "Direct link to values")

`NumberFormatValues`

#### Returns[​](#returns "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`PatternFormatProps.isAllowed`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`PatternFormatProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`PatternFormatProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`PatternFormatProps.itemRef`

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`PatternFormatProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`PatternFormatProps.itemType`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the pattern format input.

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`PatternFormatProps.lang`

***

### list?[​](#list "Direct link to list?")

> `optional` **list**: `string`

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`PatternFormatProps.list`

***

### mask?[​](#mask "Direct link to mask?")

> `optional` **mask**: `string` | `string`\[]

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`PatternFormatProps.mask`

***

### max?[​](#max "Direct link to max?")

> `optional` **max**: `string` | `number`

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`PatternFormatProps.max`

***

### maxLength?[​](#maxlength "Direct link to maxLength?")

> `optional` **maxLength**: `number`

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`PatternFormatProps.maxLength`

***

### min?[​](#min "Direct link to min?")

> `optional` **min**: `string` | `number`

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`PatternFormatProps.min`

***

### minLength?[​](#minlength "Direct link to minLength?")

> `optional` **minLength**: `number`

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`PatternFormatProps.minLength`

***

### multiple?[​](#multiple "Direct link to multiple?")

> `optional` **multiple**: `boolean`

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`PatternFormatProps.multiple`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`PatternFormatProps.name`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`PatternFormatProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`PatternFormatProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`PatternFormatProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`PatternFormatProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`PatternFormatProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`PatternFormatProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`PatternFormatProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`PatternFormatProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`PatternFormatProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`PatternFormatProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`PatternFormatProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`PatternFormatProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`PatternFormatProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`PatternFormatProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`PatternFormatProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`PatternFormatProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`PatternFormatProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`PatternFormatProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`PatternFormatProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`PatternFormatProps.onCanPlayThroughCapture`

***

### onChange()[​](#onchange "Direct link to onChange()")

> **onChange**: (`value`) => `void`

The callback when value changes.

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Overrides[​](#overrides-1 "Direct link to Overrides")

`PatternFormatProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`PatternFormatProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`PatternFormatProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`PatternFormatProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`PatternFormatProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`PatternFormatProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`PatternFormatProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`PatternFormatProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`PatternFormatProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`PatternFormatProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`PatternFormatProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`PatternFormatProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`PatternFormatProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`PatternFormatProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`PatternFormatProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`PatternFormatProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`PatternFormatProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`PatternFormatProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`PatternFormatProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`PatternFormatProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`PatternFormatProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`PatternFormatProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`PatternFormatProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`PatternFormatProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`PatternFormatProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`PatternFormatProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`PatternFormatProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`PatternFormatProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`PatternFormatProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`PatternFormatProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`PatternFormatProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`PatternFormatProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`PatternFormatProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`PatternFormatProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`PatternFormatProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`PatternFormatProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`PatternFormatProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`PatternFormatProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`PatternFormatProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`PatternFormatProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`PatternFormatProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`PatternFormatProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`PatternFormatProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`PatternFormatProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`PatternFormatProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`PatternFormatProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`PatternFormatProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`PatternFormatProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`PatternFormatProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`PatternFormatProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`PatternFormatProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`PatternFormatProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`PatternFormatProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`PatternFormatProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`PatternFormatProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`PatternFormatProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`PatternFormatProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`PatternFormatProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`PatternFormatProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`PatternFormatProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`PatternFormatProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`PatternFormatProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`PatternFormatProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`PatternFormatProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`PatternFormatProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`PatternFormatProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`PatternFormatProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`PatternFormatProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`PatternFormatProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`PatternFormatProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`PatternFormatProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`PatternFormatProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`PatternFormatProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`PatternFormatProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`PatternFormatProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`PatternFormatProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`PatternFormatProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`PatternFormatProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`PatternFormatProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`PatternFormatProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`PatternFormatProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`PatternFormatProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`PatternFormatProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`PatternFormatProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`PatternFormatProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`PatternFormatProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`PatternFormatProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`PatternFormatProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`PatternFormatProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`PatternFormatProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`PatternFormatProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`PatternFormatProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`PatternFormatProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`PatternFormatProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`PatternFormatProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`PatternFormatProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`PatternFormatProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`PatternFormatProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`PatternFormatProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`PatternFormatProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`PatternFormatProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`PatternFormatProps.onPointerUpCapture`

***

### onPressEnter?[​](#onpressenter "Direct link to onPressEnter?")

> `optional` **onPressEnter**: `KeyboardEventHandler`<`HTMLInputElement`>

Called on press enter

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`PatternFormatProps.onPressEnter`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`PatternFormatProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`PatternFormatProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`PatternFormatProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`PatternFormatProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`PatternFormatProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`PatternFormatProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`PatternFormatProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`PatternFormatProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`PatternFormatProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`PatternFormatProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`PatternFormatProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`PatternFormatProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`PatternFormatProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`PatternFormatProps.onSeekingCapture`

***

### onSelect?[​](#onselect "Direct link to onSelect?")

> `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`PatternFormatProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`PatternFormatProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`PatternFormatProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`PatternFormatProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`PatternFormatProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`PatternFormatProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`PatternFormatProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`PatternFormatProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`PatternFormatProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`PatternFormatProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`PatternFormatProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`PatternFormatProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`PatternFormatProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`PatternFormatProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`PatternFormatProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`PatternFormatProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`PatternFormatProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`PatternFormatProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`PatternFormatProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`PatternFormatProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`PatternFormatProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`PatternFormatProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`PatternFormatProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`PatternFormatProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`PatternFormatProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`PatternFormatProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`PatternFormatProps.onTransitionStartCapture`

***

### onValueChange?[​](#onvaluechange "Direct link to onValueChange?")

> `optional` **onValueChange**: `OnValueChange`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`PatternFormatProps.onValueChange`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`PatternFormatProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`PatternFormatProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`PatternFormatProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`PatternFormatProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`PatternFormatProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`>

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`PatternFormatProps.onWheelCapture`

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-32 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`PatternFormatProps.part`

***

### pattern?[​](#pattern "Direct link to pattern?")

> `optional` **pattern**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`PatternFormatProps.pattern`

***

### patternChar?[​](#patternchar "Direct link to patternChar?")

> `optional` **patternChar**: `string`

#### Inherited from[​](#inherited-from-287 "Direct link to Inherited from")

`PatternFormatProps.patternChar`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `string`

#### Inherited from[​](#inherited-from-288 "Direct link to Inherited from")

`PatternFormatProps.placeholder`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-289 "Direct link to Inherited from")

`PatternFormatProps.plaintext`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-290 "Direct link to Inherited from")

`PatternFormatProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-291 "Direct link to Inherited from")

`PatternFormatProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-292 "Direct link to Inherited from")

`PatternFormatProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-293 "Direct link to Inherited from")

`PatternFormatProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-294 "Direct link to Inherited from")

`PatternFormatProps.property`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-295 "Direct link to Inherited from")

`PatternFormatProps.radioGroup`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

#### Inherited from[​](#inherited-from-296 "Direct link to Inherited from")

`PatternFormatProps.readOnly`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-297 "Direct link to Inherited from")

`PatternFormatProps.rel`

***

### renderText()?[​](#rendertext "Direct link to renderText()?")

> `optional` **renderText**: (`formattedValue`, `otherProps`) => `ReactNode`

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### formattedValue[​](#formattedvalue "Direct link to formattedValue")

`string`

##### otherProps[​](#otherprops "Direct link to otherProps")

`Partial`<`NumberFormatBase`>

#### Returns[​](#returns-2 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-298 "Direct link to Inherited from")

`PatternFormatProps.renderText`

***

### required?[​](#required "Direct link to required?")

> `optional` **required**: `boolean`

#### Inherited from[​](#inherited-from-299 "Direct link to Inherited from")

`PatternFormatProps.required`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-300 "Direct link to Inherited from")

`PatternFormatProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-301 "Direct link to Inherited from")

`PatternFormatProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-302 "Direct link to Inherited from")

`PatternFormatProps.rev`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-303 "Direct link to Inherited from")

`PatternFormatProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-304 "Direct link to Inherited from")

`PatternFormatProps.security`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A component can have different sizes

#### Inherited from[​](#inherited-from-305 "Direct link to Inherited from")

`PatternFormatProps.size`

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-306 "Direct link to Inherited from")

`PatternFormatProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-307 "Direct link to Inherited from")

`PatternFormatProps.spellCheck`

***

### src?[​](#src "Direct link to src?")

> `optional` **src**: `string`

#### Inherited from[​](#inherited-from-308 "Direct link to Inherited from")

`PatternFormatProps.src`

***

### step?[​](#step "Direct link to step?")

> `optional` **step**: `string` | `number`

#### Inherited from[​](#inherited-from-309 "Direct link to Inherited from")

`PatternFormatProps.step`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-310 "Direct link to Inherited from")

`PatternFormatProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-311 "Direct link to Inherited from")

`PatternFormatProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-312 "Direct link to Inherited from")

`PatternFormatProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-313 "Direct link to Inherited from")

`PatternFormatProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-314 "Direct link to Inherited from")

`PatternFormatProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-315 "Direct link to Inherited from")

`PatternFormatProps.translate`

***

### type?[​](#type "Direct link to type?")

> `optional` **type**: `"text"` | `"tel"` | `"password"`

#### Inherited from[​](#inherited-from-316 "Direct link to Inherited from")

`PatternFormatProps.type`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-317 "Direct link to Inherited from")

`PatternFormatProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-318 "Direct link to Inherited from")

`PatternFormatProps.unselectable`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `null` | `string` | `number`

#### Inherited from[​](#inherited-from-319 "Direct link to Inherited from")

`PatternFormatProps.value`

***

### valueIsNumericString?[​](#valueisnumericstring "Direct link to valueIsNumericString?")

> `optional` **valueIsNumericString**: `boolean`

#### Inherited from[​](#inherited-from-320 "Direct link to Inherited from")

`PatternFormatProps.valueIsNumericString`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-321 "Direct link to Inherited from")

`PatternFormatProps.vocab`

***

### width?[​](#width "Direct link to width?")

> `optional` **width**: `string` | `number`

#### Inherited from[​](#inherited-from-322 "Direct link to Inherited from")

`PatternFormatProps.width`


---

# Interface: RsRadioGroupProps

Props for the RsRadioGroup component.

## Extends[​](#extends "Direct link to Extends")

* `RadioGroupProps`<`string`>

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `"default"` | `"picker"`

A radio group can have different appearances

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`RadioGroupProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`RadioGroupProps.as`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`RadioGroupProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`RadioGroupProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`RadioGroupProps.classPrefix`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string`

Initial value

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`RadioGroupProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

Set the component to be disabled and cannot be entered

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`RadioGroupProps.disabled`

***

### inline?[​](#inline "Direct link to inline?")

> `optional` **inline**: `boolean`

Inline layout

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`RadioGroupProps.inline`

***

### items[​](#items "Direct link to items")

> **items**: [`LabeledValue`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue)\[]

The items for the radio group.

***

### label?[​](#label "Direct link to label?")

> `optional` **label**: `string`

The label for the radio group.

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name to use for form

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`RadioGroupProps.name`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`string`

the value.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides "Direct link to Overrides")

`RadioGroupProps.onChange`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`RadioGroupProps.plaintext`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`RadioGroupProps.readOnly`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`RadioGroupProps.style`

***

### value?[​](#value-1 "Direct link to value?")

> `optional` **value**: `string`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`RadioGroupProps.value`


---

# Interface: RsSearchProps

Props for the RsSearch component.

## Extends[​](#extends "Direct link to Extends")

* `InputPickerProps`.`LoadDataProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`InputPickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`InputPickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`InputPickerProps.block`

***

### cacheData?[​](#cachedata "Direct link to cacheData?")

> `optional` **cacheData**: `InputItemDataType`<`any`>\[]

Option to cache value when searching asynchronously

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`InputPickerProps.cacheData`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`InputPickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`InputPickerProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`InputPickerProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`InputPickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`InputPickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`InputPickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`InputPickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`InputPickerProps.containerPadding`

***

### creatable?[​](#creatable "Direct link to creatable?")

> `optional` **creatable**: `boolean`

Settings can create new options

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`InputPickerProps.creatable`

***

### data[​](#data "Direct link to data")

> **data**: `InputItemDataType`<`string` | `number`>\[]

The data of the component.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`InputPickerProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`InputPickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `any`

Initial value

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`InputPickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`InputPickerProps.disabled`

***

### disabledItemValues?[​](#disableditemvalues "Direct link to disabledItemValues?")

> `optional` **disabledItemValues**: `any`

Disabled items

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`InputPickerProps.disabledItemValues`

***

### disableVirtualized?[​](#disablevirtualized "Direct link to disableVirtualized?")

> `optional` **disableVirtualized**: `boolean`

Flag, if true, the virtualized will be disabled, false otherwise.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`LoadDataProps.disableVirtualized`

***

### groupBy?[​](#groupby "Direct link to groupBy?")

> `optional` **groupBy**: `string`

Set group condition key in data

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`InputPickerProps.groupBy`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`InputPickerProps.id`

***

### label[​](#label "Direct link to label")

> **label**: `string`

The label for the search input.

***

### labelKey?[​](#labelkey "Direct link to labelKey?")

> `optional` **labelKey**: `string`

The key to use for displaying the options in the data.

#### Default[​](#default-1 "Direct link to Default")

```
label
```

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`InputPickerProps.labelKey`

***

### listProps?[​](#listprops "Direct link to listProps?")

> `optional` **listProps**: `Partial`<`ListProps`<`any`>>

Virtualized List Props

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`InputPickerProps.listProps`

***

### loading?[​](#loading "Direct link to loading?")

> `optional` **loading**: `boolean`

Whether to display an loading indicator on toggle button

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`InputPickerProps.loading`

***

### locale?[​](#locale "Direct link to locale?")

> `optional` **locale**: `Partial`<`InputPickerLocale`>

Custom locale

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`InputPickerProps.locale`

***

### menuAutoWidth?[​](#menuautowidth "Direct link to menuAutoWidth?")

> `optional` **menuAutoWidth**: `boolean`

Picker menu auto width

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`InputPickerProps.menuAutoWidth`

***

### menuClassName?[​](#menuclassname "Direct link to menuClassName?")

> `optional` **menuClassName**: `string`

A CSS class to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`InputPickerProps.menuClassName`

***

### menuMaxHeight?[​](#menumaxheight "Direct link to menuMaxHeight?")

> `optional` **menuMaxHeight**: `number`

Picker menu max Height

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`InputPickerProps.menuMaxHeight`

***

### menuStyle?[​](#menustyle "Direct link to menuStyle?")

> `optional` **menuStyle**: `CSSProperties`

A style to apply to the Menu DOM node.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`InputPickerProps.menuStyle`

***

### name?[​](#name "Direct link to name?")

> `optional` **name**: `string`

Name of the form field

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`InputPickerProps.name`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`Element`>

The `onBlur` attribute for the `input` element.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`InputPickerProps.onBlur`

***

### onChange()?[​](#onchange "Direct link to onChange()?")

> `optional` **onChange**: (`value`) => `void`

Called after the value has been changed.

#### Parameters[​](#parameters "Direct link to Parameters")

##### value[​](#value "Direct link to value")

`any`

the value.

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Overrides[​](#overrides "Direct link to Overrides")

`InputPickerProps.onChange`

***

### onClean()?[​](#onclean "Direct link to onClean()?")

> `optional` **onClean**: (`event`) => `void`

Called when clean

#### Parameters[​](#parameters-1 "Direct link to Parameters")

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-1 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`InputPickerProps.onClean`

***

### onClose()?[​](#onclose "Direct link to onClose()?")

> `optional` **onClose**: () => `void`

Called when Modal is closed

#### Returns[​](#returns-2 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`InputPickerProps.onClose`

***

### onCreate()?[​](#oncreate "Direct link to onCreate()?")

> `optional` **onCreate**: (`value`, `item`, `event`) => `void`

Called when the option is created

#### Parameters[​](#parameters-2 "Direct link to Parameters")

##### value[​](#value-1 "Direct link to value")

`any`

##### item[​](#item "Direct link to item")

`ItemDataType`

##### event[​](#event-1 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-3 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`InputPickerProps.onCreate`

***

### onEnter()?[​](#onenter "Direct link to onEnter()?")

> `optional` **onEnter**: (`node`) => `void`

Callback fired before the Modal transitions in

#### Parameters[​](#parameters-3 "Direct link to Parameters")

##### node[​](#node "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-4 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`InputPickerProps.onEnter`

***

### onEntered()?[​](#onentered "Direct link to onEntered()?")

> `optional` **onEntered**: (`node`) => `void`

Callback fired after the Modal finishes transitioning in

#### Parameters[​](#parameters-4 "Direct link to Parameters")

##### node[​](#node-1 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-5 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`InputPickerProps.onEntered`

***

### onEntering()?[​](#onentering "Direct link to onEntering()?")

> `optional` **onEntering**: (`node`) => `void`

Callback fired as the Modal begins to transition in

#### Parameters[​](#parameters-5 "Direct link to Parameters")

##### node[​](#node-2 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-6 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`InputPickerProps.onEntering`

***

### onExit()?[​](#onexit "Direct link to onExit()?")

> `optional` **onExit**: (`node`) => `void`

Callback fired right before the Modal transitions out

#### Parameters[​](#parameters-6 "Direct link to Parameters")

##### node[​](#node-3 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-7 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`InputPickerProps.onExit`

***

### onExited()?[​](#onexited "Direct link to onExited()?")

> `optional` **onExited**: (`node`) => `void`

Callback fired after the Modal finishes transitioning out

#### Parameters[​](#parameters-7 "Direct link to Parameters")

##### node[​](#node-4 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-8 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`InputPickerProps.onExited`

***

### onExiting()?[​](#onexiting "Direct link to onExiting()?")

> `optional` **onExiting**: (`node`) => `void`

Callback fired as the Modal begins to transition out

#### Parameters[​](#parameters-8 "Direct link to Parameters")

##### node[​](#node-5 "Direct link to node")

`HTMLElement`

#### Returns[​](#returns-9 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`InputPickerProps.onExiting`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`Element`>

The `onFocus` attribute for the `input` element.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`InputPickerProps.onFocus`

***

### onGroupTitleClick()?[​](#ongrouptitleclick "Direct link to onGroupTitleClick()?")

> `optional` **onGroupTitleClick**: (`event`) => `void`

Called after clicking the group title

#### Parameters[​](#parameters-9 "Direct link to Parameters")

##### event[​](#event-2 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-10 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`InputPickerProps.onGroupTitleClick`

***

### onLoadData?[​](#onloaddata "Direct link to onLoadData?")

> `optional` **onLoadData**: [`LoadDataHandler`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadDataHandler)

The callback function called when data should be load.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`LoadDataProps.onLoadData`

***

### onOpen()?[​](#onopen "Direct link to onOpen()?")

> `optional` **onOpen**: () => `void`

Called when Modal is displayed

#### Returns[​](#returns-11 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`InputPickerProps.onOpen`

***

### onSearch()?[​](#onsearch "Direct link to onSearch()?")

> `optional` **onSearch**: (`searchKeyword`, `event?`) => `void`

Called when searching

#### Parameters[​](#parameters-10 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword "Direct link to searchKeyword")

`string`

##### event?[​](#event-3 "Direct link to event?")

`SyntheticEvent`<`Element`, `Event`>

#### Returns[​](#returns-12 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`InputPickerProps.onSearch`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`value`, `item`, `event`) => `void`

Called when the option is selected

#### Parameters[​](#parameters-11 "Direct link to Parameters")

##### value[​](#value-2 "Direct link to value")

`any`

##### item[​](#item-1 "Direct link to item")

`ItemDataType`<`any`>

##### event[​](#event-4 "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns-13 "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`InputPickerProps.onSelect`

***

### open?[​](#open "Direct link to open?")

> `optional` **open**: `boolean`

Open the menu and control it

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`InputPickerProps.open`

***

### placeholder?[​](#placeholder "Direct link to placeholder?")

> `optional` **placeholder**: `ReactNode`

Placeholder text

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`InputPickerProps.placeholder`

***

### placement?[​](#placement "Direct link to placement?")

> `optional` **placement**: `Placement`

The placement of picker

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`InputPickerProps.placement`

***

### plaintext?[​](#plaintext "Direct link to plaintext?")

> `optional` **plaintext**: `boolean`

Render the control as plain text

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`InputPickerProps.plaintext`

***

### preload?[​](#preload "Direct link to preload?")

> `optional` **preload**: `boolean`

Flag, if true, the data will be loaded in advance, before opening the dropdown, false otherwise.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`LoadDataProps.preload`

***

### preventOverflow?[​](#preventoverflow "Direct link to preventOverflow?")

> `optional` **preventOverflow**: `boolean`

Prevent floating element overflow

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`InputPickerProps.preventOverflow`

***

### readOnly?[​](#readonly "Direct link to readOnly?")

> `optional` **readOnly**: `boolean`

Make the control readonly

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`InputPickerProps.readOnly`

***

### renderExtraFooter()?[​](#renderextrafooter "Direct link to renderExtraFooter()?")

> `optional` **renderExtraFooter**: () => `ReactNode`

Custom render extra footer

#### Returns[​](#returns-14 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`InputPickerProps.renderExtraFooter`

***

### renderMenu()?[​](#rendermenu "Direct link to renderMenu()?")

> `optional` **renderMenu**: (`menu`) => `ReactNode`

Customizing the Rendering Menu list

#### Parameters[​](#parameters-12 "Direct link to Parameters")

##### menu[​](#menu "Direct link to menu")

`ReactNode`

#### Returns[​](#returns-15 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`InputPickerProps.renderMenu`

***

### renderMenuGroup()?[​](#rendermenugroup "Direct link to renderMenuGroup()?")

> `optional` **renderMenuGroup**: (`title`, `item`) => `ReactNode`

Custom render menu group

#### Parameters[​](#parameters-13 "Direct link to Parameters")

##### title[​](#title "Direct link to title")

`ReactNode`

##### item[​](#item-2 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-16 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`InputPickerProps.renderMenuGroup`

***

### renderMenuItem()?[​](#rendermenuitem "Direct link to renderMenuItem()?")

> `optional` **renderMenuItem**: (`label`, `item`) => `ReactNode`

Custom render menuItems

#### Parameters[​](#parameters-14 "Direct link to Parameters")

##### label[​](#label-1 "Direct link to label")

`ReactNode`

##### item[​](#item-3 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-17 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`InputPickerProps.renderMenuItem`

***

### renderValue()?[​](#rendervalue "Direct link to renderValue()?")

> `optional` **renderValue**: (`value`, `item`, `selectedElement`) => `ReactNode`

#### Parameters[​](#parameters-15 "Direct link to Parameters")

##### value[​](#value-3 "Direct link to value")

`any`

##### item[​](#item-4 "Direct link to item")

`ItemDataType`<`any`>

##### selectedElement[​](#selectedelement "Direct link to selectedElement")

`ReactNode`

#### Returns[​](#returns-18 "Direct link to Returns")

`ReactNode`

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`InputPickerProps.renderValue`

***

### searchable?[​](#searchable "Direct link to searchable?")

> `optional` **searchable**: `boolean`

Whether dispaly search input box

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`InputPickerProps.searchable`

***

### searchBy()?[​](#searchby "Direct link to searchBy()?")

> `optional` **searchBy**: (`keyword`, `label`, `item`) => `boolean`

Custom search rules.

#### Parameters[​](#parameters-16 "Direct link to Parameters")

##### keyword[​](#keyword "Direct link to keyword")

`string`

##### label[​](#label-2 "Direct link to label")

`ReactNode`

##### item[​](#item-5 "Direct link to item")

`ItemDataType`

#### Returns[​](#returns-19 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`InputPickerProps.searchBy`

***

### shouldDisplayCreateOption()?[​](#shoulddisplaycreateoption "Direct link to shouldDisplayCreateOption()?")

> `optional` **shouldDisplayCreateOption**: (`searchKeyword`, `filteredData`) => `boolean`

Customize whether to display "Create option" action with given textbox value

By default, InputPicker hides "Create option" action when textbox value matches any filtered item's \[valueKey] property

#### Parameters[​](#parameters-17 "Direct link to Parameters")

##### searchKeyword[​](#searchkeyword-1 "Direct link to searchKeyword")

`string`

Value of the textbox

##### filteredData[​](#filtereddata "Direct link to filteredData")

`InputItemDataType`<`any`>\[]

The items filtered by the searchKeyword

#### Returns[​](#returns-20 "Direct link to Returns")

`boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`InputPickerProps.shouldDisplayCreateOption`

***

### size?[​](#size "Direct link to size?")

> `optional` **size**: `Size`

A picker can have different sizes

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`InputPickerProps.size`

***

### sort()?[​](#sort "Direct link to sort()?")

> `optional` **sort**: (`isGroup`) => (`a`, `b`) => `number`

Sort options

#### Parameters[​](#parameters-18 "Direct link to Parameters")

##### isGroup[​](#isgroup "Direct link to isGroup")

`boolean`

#### Returns[​](#returns-21 "Direct link to Returns")

> (`a`, `b`): `number`

##### Parameters[​](#parameters-19 "Direct link to Parameters")

###### a[​](#a "Direct link to a")

`any`

###### b[​](#b "Direct link to b")

`any`

##### Returns[​](#returns-22 "Direct link to Returns")

`number`

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`InputPickerProps.sort`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`InputPickerProps.style`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`InputPickerProps.tabIndex`

***

### toggleAs?[​](#toggleas "Direct link to toggleAs?")

> `optional` **toggleAs**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`InputPickerProps.toggleAs`

***

### value?[​](#value-4 "Direct link to value?")

> `optional` **value**: `any`

Current value of the component. Creates a controlled component

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`InputPickerProps.value`

***

### valueKey?[​](#valuekey "Direct link to valueKey?")

> `optional` **valueKey**: `string`

The key to use for setting the option value in the data.

#### Default[​](#default-2 "Direct link to Default")

```
value
```

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`InputPickerProps.valueKey`

***

### virtualized?[​](#virtualized "Direct link to virtualized?")

> `optional` **virtualized**: `boolean`

Whether using virtualized list

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`InputPickerProps.virtualized`


---

# Interface: RsStaticContentProps

Props for the RsStaticContent component.

## Properties[​](#properties "Direct link to Properties")

### allowHtml[​](#allowhtml "Direct link to allowHtml")

> **allowHtml**: `boolean`

Whether to allow HTML content.

***

### content[​](#content "Direct link to content")

> **content**: `string`

The content to display.


---

# Interface: RsTabProps

Props for the RsTab component.

## Extends[​](#extends "Direct link to Extends")

* `NavProps`

## Properties[​](#properties "Direct link to Properties")

### about?[​](#about "Direct link to about?")

> `optional` **about**: `string`

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`NavProps.about`

***

### accessKey?[​](#accesskey "Direct link to accessKey?")

> `optional` **accessKey**: `string`

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`NavProps.accessKey`

***

### activeKey?[​](#activekey "Direct link to activeKey?")

> `optional` **activeKey**: `any`

The active key of the Nav component.

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`NavProps.activeKey`

***

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `"default"` | `"tabs"` | `"subtle"` | `"pills"`

The appearance style of the Nav component.

#### Default[​](#default "Direct link to Default")

```
'default'
```

#### Version[​](#version "Direct link to Version")

'pills' is supported in version 5.68.0

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`NavProps.appearance`

***

### aria-activedescendant?[​](#aria-activedescendant "Direct link to aria-activedescendant?")

> `optional` **aria-activedescendant**: `string`

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`NavProps.aria-activedescendant`

***

### aria-atomic?[​](#aria-atomic "Direct link to aria-atomic?")

> `optional` **aria-atomic**: `Booleanish`

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`NavProps.aria-atomic`

***

### aria-autocomplete?[​](#aria-autocomplete "Direct link to aria-autocomplete?")

> `optional` **aria-autocomplete**: `"none"` | `"list"` | `"inline"` | `"both"`

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`NavProps.aria-autocomplete`

***

### aria-braillelabel?[​](#aria-braillelabel "Direct link to aria-braillelabel?")

> `optional` **aria-braillelabel**: `string`

Defines a string value that labels the current element, which is intended to be converted into Braille.

#### See[​](#see "Direct link to See")

aria-label.

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`NavProps.aria-braillelabel`

***

### aria-brailleroledescription?[​](#aria-brailleroledescription "Direct link to aria-brailleroledescription?")

> `optional` **aria-brailleroledescription**: `string`

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

#### See[​](#see-1 "Direct link to See")

aria-roledescription.

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`NavProps.aria-brailleroledescription`

***

### aria-busy?[​](#aria-busy "Direct link to aria-busy?")

> `optional` **aria-busy**: `Booleanish`

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`NavProps.aria-busy`

***

### aria-checked?[​](#aria-checked "Direct link to aria-checked?")

> `optional` **aria-checked**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

#### See[​](#see-2 "Direct link to See")

* aria-pressed
* aria-selected.

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`NavProps.aria-checked`

***

### aria-colcount?[​](#aria-colcount "Direct link to aria-colcount?")

> `optional` **aria-colcount**: `number`

Defines the total number of columns in a table, grid, or treegrid.

#### See[​](#see-3 "Direct link to See")

aria-colindex.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`NavProps.aria-colcount`

***

### aria-colindex?[​](#aria-colindex "Direct link to aria-colindex?")

> `optional` **aria-colindex**: `number`

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

#### See[​](#see-4 "Direct link to See")

* aria-colcount
* aria-colspan.

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`NavProps.aria-colindex`

***

### aria-colindextext?[​](#aria-colindextext "Direct link to aria-colindextext?")

> `optional` **aria-colindextext**: `string`

Defines a human readable text alternative of aria-colindex.

#### See[​](#see-5 "Direct link to See")

aria-rowindextext.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`NavProps.aria-colindextext`

***

### aria-colspan?[​](#aria-colspan "Direct link to aria-colspan?")

> `optional` **aria-colspan**: `number`

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-6 "Direct link to See")

* aria-colindex
* aria-rowspan.

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`NavProps.aria-colspan`

***

### aria-controls?[​](#aria-controls "Direct link to aria-controls?")

> `optional` **aria-controls**: `string`

Identifies the element (or elements) whose contents or presence are controlled by the current element.

#### See[​](#see-7 "Direct link to See")

aria-owns.

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`NavProps.aria-controls`

***

### aria-current?[​](#aria-current "Direct link to aria-current?")

> `optional` **aria-current**: `boolean` | `"date"` | `"time"` | `"page"` | `"true"` | `"false"` | `"step"` | `"location"`

Indicates the element that represents the current item within a container or set of related elements.

#### Inherited from[​](#inherited-from-16 "Direct link to Inherited from")

`NavProps.aria-current`

***

### aria-describedby?[​](#aria-describedby "Direct link to aria-describedby?")

> `optional` **aria-describedby**: `string`

Identifies the element (or elements) that describes the object.

#### See[​](#see-8 "Direct link to See")

aria-labelledby

#### Inherited from[​](#inherited-from-17 "Direct link to Inherited from")

`NavProps.aria-describedby`

***

### aria-description?[​](#aria-description "Direct link to aria-description?")

> `optional` **aria-description**: `string`

Defines a string value that describes or annotates the current element.

#### See[​](#see-9 "Direct link to See")

related aria-describedby.

#### Inherited from[​](#inherited-from-18 "Direct link to Inherited from")

`NavProps.aria-description`

***

### aria-details?[​](#aria-details "Direct link to aria-details?")

> `optional` **aria-details**: `string`

Identifies the element that provides a detailed, extended description for the object.

#### See[​](#see-10 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-19 "Direct link to Inherited from")

`NavProps.aria-details`

***

### aria-disabled?[​](#aria-disabled "Direct link to aria-disabled?")

> `optional` **aria-disabled**: `Booleanish`

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

#### See[​](#see-11 "Direct link to See")

* aria-hidden
* aria-readonly.

#### Inherited from[​](#inherited-from-20 "Direct link to Inherited from")

`NavProps.aria-disabled`

***

### ~~aria-dropeffect?~~[​](#aria-dropeffect "Direct link to aria-dropeffect")

> `optional` **aria-dropeffect**: `"link"` | `"none"` | `"copy"` | `"move"` | `"execute"` | `"popup"`

Indicates what functions can be performed when a dragged object is released on the drop target.

#### Deprecated[​](#deprecated "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-21 "Direct link to Inherited from")

`NavProps.aria-dropeffect`

***

### aria-errormessage?[​](#aria-errormessage "Direct link to aria-errormessage?")

> `optional` **aria-errormessage**: `string`

Identifies the element that provides an error message for the object.

#### See[​](#see-12 "Direct link to See")

* aria-invalid
* aria-describedby.

#### Inherited from[​](#inherited-from-22 "Direct link to Inherited from")

`NavProps.aria-errormessage`

***

### aria-expanded?[​](#aria-expanded "Direct link to aria-expanded?")

> `optional` **aria-expanded**: `Booleanish`

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

#### Inherited from[​](#inherited-from-23 "Direct link to Inherited from")

`NavProps.aria-expanded`

***

### aria-flowto?[​](#aria-flowto "Direct link to aria-flowto?")

> `optional` **aria-flowto**: `string`

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

#### Inherited from[​](#inherited-from-24 "Direct link to Inherited from")

`NavProps.aria-flowto`

***

### ~~aria-grabbed?~~[​](#aria-grabbed "Direct link to aria-grabbed")

> `optional` **aria-grabbed**: `Booleanish`

Indicates an element's "grabbed" state in a drag-and-drop operation.

#### Deprecated[​](#deprecated-1 "Direct link to Deprecated")

in ARIA 1.1

#### Inherited from[​](#inherited-from-25 "Direct link to Inherited from")

`NavProps.aria-grabbed`

***

### aria-haspopup?[​](#aria-haspopup "Direct link to aria-haspopup?")

> `optional` **aria-haspopup**: `boolean` | `"grid"` | `"dialog"` | `"menu"` | `"true"` | `"false"` | `"listbox"` | `"tree"`

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

#### Inherited from[​](#inherited-from-26 "Direct link to Inherited from")

`NavProps.aria-haspopup`

***

### aria-hidden?[​](#aria-hidden "Direct link to aria-hidden?")

> `optional` **aria-hidden**: `Booleanish`

Indicates whether the element is exposed to an accessibility API.

#### See[​](#see-13 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-27 "Direct link to Inherited from")

`NavProps.aria-hidden`

***

### aria-invalid?[​](#aria-invalid "Direct link to aria-invalid?")

> `optional` **aria-invalid**: `boolean` | `"true"` | `"false"` | `"grammar"` | `"spelling"`

Indicates the entered value does not conform to the format expected by the application.

#### See[​](#see-14 "Direct link to See")

aria-errormessage.

#### Inherited from[​](#inherited-from-28 "Direct link to Inherited from")

`NavProps.aria-invalid`

***

### aria-keyshortcuts?[​](#aria-keyshortcuts "Direct link to aria-keyshortcuts?")

> `optional` **aria-keyshortcuts**: `string`

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

#### Inherited from[​](#inherited-from-29 "Direct link to Inherited from")

`NavProps.aria-keyshortcuts`

***

### aria-label?[​](#aria-label "Direct link to aria-label?")

> `optional` **aria-label**: `string`

Defines a string value that labels the current element.

#### See[​](#see-15 "Direct link to See")

aria-labelledby.

#### Inherited from[​](#inherited-from-30 "Direct link to Inherited from")

`NavProps.aria-label`

***

### aria-labelledby?[​](#aria-labelledby "Direct link to aria-labelledby?")

> `optional` **aria-labelledby**: `string`

Identifies the element (or elements) that labels the current element.

#### See[​](#see-16 "Direct link to See")

aria-describedby.

#### Inherited from[​](#inherited-from-31 "Direct link to Inherited from")

`NavProps.aria-labelledby`

***

### aria-level?[​](#aria-level "Direct link to aria-level?")

> `optional` **aria-level**: `number`

Defines the hierarchical level of an element within a structure.

#### Inherited from[​](#inherited-from-32 "Direct link to Inherited from")

`NavProps.aria-level`

***

### aria-live?[​](#aria-live "Direct link to aria-live?")

> `optional` **aria-live**: `"off"` | `"assertive"` | `"polite"`

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

#### Inherited from[​](#inherited-from-33 "Direct link to Inherited from")

`NavProps.aria-live`

***

### aria-modal?[​](#aria-modal "Direct link to aria-modal?")

> `optional` **aria-modal**: `Booleanish`

Indicates whether an element is modal when displayed.

#### Inherited from[​](#inherited-from-34 "Direct link to Inherited from")

`NavProps.aria-modal`

***

### aria-multiline?[​](#aria-multiline "Direct link to aria-multiline?")

> `optional` **aria-multiline**: `Booleanish`

Indicates whether a text box accepts multiple lines of input or only a single line.

#### Inherited from[​](#inherited-from-35 "Direct link to Inherited from")

`NavProps.aria-multiline`

***

### aria-multiselectable?[​](#aria-multiselectable "Direct link to aria-multiselectable?")

> `optional` **aria-multiselectable**: `Booleanish`

Indicates that the user may select more than one item from the current selectable descendants.

#### Inherited from[​](#inherited-from-36 "Direct link to Inherited from")

`NavProps.aria-multiselectable`

***

### aria-orientation?[​](#aria-orientation "Direct link to aria-orientation?")

> `optional` **aria-orientation**: `"horizontal"` | `"vertical"`

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

#### Inherited from[​](#inherited-from-37 "Direct link to Inherited from")

`NavProps.aria-orientation`

***

### aria-owns?[​](#aria-owns "Direct link to aria-owns?")

> `optional` **aria-owns**: `string`

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

#### See[​](#see-17 "Direct link to See")

aria-controls.

#### Inherited from[​](#inherited-from-38 "Direct link to Inherited from")

`NavProps.aria-owns`

***

### aria-placeholder?[​](#aria-placeholder "Direct link to aria-placeholder?")

> `optional` **aria-placeholder**: `string`

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

#### Inherited from[​](#inherited-from-39 "Direct link to Inherited from")

`NavProps.aria-placeholder`

***

### aria-posinset?[​](#aria-posinset "Direct link to aria-posinset?")

> `optional` **aria-posinset**: `number`

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-18 "Direct link to See")

aria-setsize.

#### Inherited from[​](#inherited-from-40 "Direct link to Inherited from")

`NavProps.aria-posinset`

***

### aria-pressed?[​](#aria-pressed "Direct link to aria-pressed?")

> `optional` **aria-pressed**: `boolean` | `"true"` | `"false"` | `"mixed"`

Indicates the current "pressed" state of toggle buttons.

#### See[​](#see-19 "Direct link to See")

* aria-checked
* aria-selected.

#### Inherited from[​](#inherited-from-41 "Direct link to Inherited from")

`NavProps.aria-pressed`

***

### aria-readonly?[​](#aria-readonly "Direct link to aria-readonly?")

> `optional` **aria-readonly**: `Booleanish`

Indicates that the element is not editable, but is otherwise operable.

#### See[​](#see-20 "Direct link to See")

aria-disabled.

#### Inherited from[​](#inherited-from-42 "Direct link to Inherited from")

`NavProps.aria-readonly`

***

### aria-relevant?[​](#aria-relevant "Direct link to aria-relevant?")

> `optional` **aria-relevant**: `"all"` | `"text"` | `"additions"` | `"additions removals"` | `"additions text"` | `"removals"` | `"removals additions"` | `"removals text"` | `"text additions"` | `"text removals"`

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

#### See[​](#see-21 "Direct link to See")

aria-atomic.

#### Inherited from[​](#inherited-from-43 "Direct link to Inherited from")

`NavProps.aria-relevant`

***

### aria-required?[​](#aria-required "Direct link to aria-required?")

> `optional` **aria-required**: `Booleanish`

Indicates that user input is required on the element before a form may be submitted.

#### Inherited from[​](#inherited-from-44 "Direct link to Inherited from")

`NavProps.aria-required`

***

### aria-roledescription?[​](#aria-roledescription "Direct link to aria-roledescription?")

> `optional` **aria-roledescription**: `string`

Defines a human-readable, author-localized description for the role of an element.

#### Inherited from[​](#inherited-from-45 "Direct link to Inherited from")

`NavProps.aria-roledescription`

***

### aria-rowcount?[​](#aria-rowcount "Direct link to aria-rowcount?")

> `optional` **aria-rowcount**: `number`

Defines the total number of rows in a table, grid, or treegrid.

#### See[​](#see-22 "Direct link to See")

aria-rowindex.

#### Inherited from[​](#inherited-from-46 "Direct link to Inherited from")

`NavProps.aria-rowcount`

***

### aria-rowindex?[​](#aria-rowindex "Direct link to aria-rowindex?")

> `optional` **aria-rowindex**: `number`

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

#### See[​](#see-23 "Direct link to See")

* aria-rowcount
* aria-rowspan.

#### Inherited from[​](#inherited-from-47 "Direct link to Inherited from")

`NavProps.aria-rowindex`

***

### aria-rowindextext?[​](#aria-rowindextext "Direct link to aria-rowindextext?")

> `optional` **aria-rowindextext**: `string`

Defines a human readable text alternative of aria-rowindex.

#### See[​](#see-24 "Direct link to See")

aria-colindextext.

#### Inherited from[​](#inherited-from-48 "Direct link to Inherited from")

`NavProps.aria-rowindextext`

***

### aria-rowspan?[​](#aria-rowspan "Direct link to aria-rowspan?")

> `optional` **aria-rowspan**: `number`

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

#### See[​](#see-25 "Direct link to See")

* aria-rowindex
* aria-colspan.

#### Inherited from[​](#inherited-from-49 "Direct link to Inherited from")

`NavProps.aria-rowspan`

***

### aria-selected?[​](#aria-selected "Direct link to aria-selected?")

> `optional` **aria-selected**: `Booleanish`

Indicates the current "selected" state of various widgets.

#### See[​](#see-26 "Direct link to See")

* aria-checked
* aria-pressed.

#### Inherited from[​](#inherited-from-50 "Direct link to Inherited from")

`NavProps.aria-selected`

***

### aria-setsize?[​](#aria-setsize "Direct link to aria-setsize?")

> `optional` **aria-setsize**: `number`

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

#### See[​](#see-27 "Direct link to See")

aria-posinset.

#### Inherited from[​](#inherited-from-51 "Direct link to Inherited from")

`NavProps.aria-setsize`

***

### aria-sort?[​](#aria-sort "Direct link to aria-sort?")

> `optional` **aria-sort**: `"none"` | `"ascending"` | `"descending"` | `"other"`

Indicates if items in a table or grid are sorted in ascending or descending order.

#### Inherited from[​](#inherited-from-52 "Direct link to Inherited from")

`NavProps.aria-sort`

***

### aria-valuemax?[​](#aria-valuemax "Direct link to aria-valuemax?")

> `optional` **aria-valuemax**: `number`

Defines the maximum allowed value for a range widget.

#### Inherited from[​](#inherited-from-53 "Direct link to Inherited from")

`NavProps.aria-valuemax`

***

### aria-valuemin?[​](#aria-valuemin "Direct link to aria-valuemin?")

> `optional` **aria-valuemin**: `number`

Defines the minimum allowed value for a range widget.

#### Inherited from[​](#inherited-from-54 "Direct link to Inherited from")

`NavProps.aria-valuemin`

***

### aria-valuenow?[​](#aria-valuenow "Direct link to aria-valuenow?")

> `optional` **aria-valuenow**: `number`

Defines the current value for a range widget.

#### See[​](#see-28 "Direct link to See")

aria-valuetext.

#### Inherited from[​](#inherited-from-55 "Direct link to Inherited from")

`NavProps.aria-valuenow`

***

### aria-valuetext?[​](#aria-valuetext "Direct link to aria-valuetext?")

> `optional` **aria-valuetext**: `string`

Defines the human readable text alternative of aria-valuenow for a range widget.

#### Inherited from[​](#inherited-from-56 "Direct link to Inherited from")

`NavProps.aria-valuetext`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-57 "Direct link to Inherited from")

`NavProps.as`

***

### autoCapitalize?[​](#autocapitalize "Direct link to autoCapitalize?")

> `optional` **autoCapitalize**: `"none"` | `string` & `object` | `"off"` | `"on"` | `"sentences"` | `"words"` | `"characters"`

#### Inherited from[​](#inherited-from-58 "Direct link to Inherited from")

`NavProps.autoCapitalize`

***

### autoCorrect?[​](#autocorrect "Direct link to autoCorrect?")

> `optional` **autoCorrect**: `string`

#### Inherited from[​](#inherited-from-59 "Direct link to Inherited from")

`NavProps.autoCorrect`

***

### autoFocus?[​](#autofocus "Direct link to autoFocus?")

> `optional` **autoFocus**: `boolean`

#### Inherited from[​](#inherited-from-60 "Direct link to Inherited from")

`NavProps.autoFocus`

***

### autoSave?[​](#autosave "Direct link to autoSave?")

> `optional` **autoSave**: `string`

#### Inherited from[​](#inherited-from-61 "Direct link to Inherited from")

`NavProps.autoSave`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-62 "Direct link to Inherited from")

`NavProps.children`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-63 "Direct link to Inherited from")

`NavProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-64 "Direct link to Inherited from")

`NavProps.classPrefix`

***

### color?[​](#color "Direct link to color?")

> `optional` **color**: `string`

#### Inherited from[​](#inherited-from-65 "Direct link to Inherited from")

`NavProps.color`

***

### content?[​](#content "Direct link to content?")

> `optional` **content**: `string`

#### Inherited from[​](#inherited-from-66 "Direct link to Inherited from")

`NavProps.content`

***

### contentEditable?[​](#contenteditable "Direct link to contentEditable?")

> `optional` **contentEditable**: `"inherit"` | `Booleanish` | `"plaintext-only"`

#### Inherited from[​](#inherited-from-67 "Direct link to Inherited from")

`NavProps.contentEditable`

***

### contextMenu?[​](#contextmenu "Direct link to contextMenu?")

> `optional` **contextMenu**: `string`

#### Inherited from[​](#inherited-from-68 "Direct link to Inherited from")

`NavProps.contextMenu`

***

### dangerouslySetInnerHTML?[​](#dangerouslysetinnerhtml "Direct link to dangerouslySetInnerHTML?")

> `optional` **dangerouslySetInnerHTML**: `object`

#### \_\_html[​](#__html "Direct link to __html")

> **\_\_html**: `string` | `TrustedHTML`

#### Inherited from[​](#inherited-from-69 "Direct link to Inherited from")

`NavProps.dangerouslySetInnerHTML`

***

### datatype?[​](#datatype "Direct link to datatype?")

> `optional` **datatype**: `string`

#### Inherited from[​](#inherited-from-70 "Direct link to Inherited from")

`NavProps.datatype`

***

### defaultActiveKey?[​](#defaultactivekey "Direct link to defaultActiveKey?")

> `optional` **defaultActiveKey**: `any`

The default active key of the Nav component.

#### Inherited from[​](#inherited-from-71 "Direct link to Inherited from")

`NavProps.defaultActiveKey`

***

### defaultChecked?[​](#defaultchecked "Direct link to defaultChecked?")

> `optional` **defaultChecked**: `boolean`

#### Inherited from[​](#inherited-from-72 "Direct link to Inherited from")

`NavProps.defaultChecked`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `string` | `number` | readonly `string`\[]

#### Inherited from[​](#inherited-from-73 "Direct link to Inherited from")

`NavProps.defaultValue`

***

### dir?[​](#dir "Direct link to dir?")

> `optional` **dir**: `string`

#### Inherited from[​](#inherited-from-74 "Direct link to Inherited from")

`NavProps.dir`

***

### draggable?[​](#draggable "Direct link to draggable?")

> `optional` **draggable**: `Booleanish`

#### Inherited from[​](#inherited-from-75 "Direct link to Inherited from")

`NavProps.draggable`

***

### enterKeyHint?[​](#enterkeyhint "Direct link to enterKeyHint?")

> `optional` **enterKeyHint**: `"search"` | `"done"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"`

#### Inherited from[​](#inherited-from-76 "Direct link to Inherited from")

`NavProps.enterKeyHint`

***

### exportparts?[​](#exportparts "Direct link to exportparts?")

> `optional` **exportparts**: `string`

#### See[​](#see-29 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/exportparts>

#### Inherited from[​](#inherited-from-77 "Direct link to Inherited from")

`NavProps.exportparts`

***

### hidden?[​](#hidden "Direct link to hidden?")

> `optional` **hidden**: `boolean`

#### Inherited from[​](#inherited-from-78 "Direct link to Inherited from")

`NavProps.hidden`

***

### id?[​](#id "Direct link to id?")

> `optional` **id**: `string`

#### Inherited from[​](#inherited-from-79 "Direct link to Inherited from")

`NavProps.id`

***

### inert?[​](#inert "Direct link to inert?")

> `optional` **inert**: `boolean`

#### See[​](#see-30 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert>

#### Inherited from[​](#inherited-from-80 "Direct link to Inherited from")

`NavProps.inert`

***

### inlist?[​](#inlist "Direct link to inlist?")

> `optional` **inlist**: `any`

#### Inherited from[​](#inherited-from-81 "Direct link to Inherited from")

`NavProps.inlist`

***

### inputMode?[​](#inputmode "Direct link to inputMode?")

> `optional` **inputMode**: `"search"` | `"none"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"`

Hints at the type of data that might be entered by the user while editing the element or its contents

#### See[​](#see-31 "Direct link to See")

<https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute>

#### Inherited from[​](#inherited-from-82 "Direct link to Inherited from")

`NavProps.inputMode`

***

### is?[​](#is "Direct link to is?")

> `optional` **is**: `string`

Specify that a standard HTML element should behave like a defined custom built-in element

#### See[​](#see-32 "Direct link to See")

<https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is>

#### Inherited from[​](#inherited-from-83 "Direct link to Inherited from")

`NavProps.is`

***

### itemID?[​](#itemid "Direct link to itemID?")

> `optional` **itemID**: `string`

#### Inherited from[​](#inherited-from-84 "Direct link to Inherited from")

`NavProps.itemID`

***

### itemProp?[​](#itemprop "Direct link to itemProp?")

> `optional` **itemProp**: `string`

#### Inherited from[​](#inherited-from-85 "Direct link to Inherited from")

`NavProps.itemProp`

***

### itemRef?[​](#itemref "Direct link to itemRef?")

> `optional` **itemRef**: `string`

#### Inherited from[​](#inherited-from-86 "Direct link to Inherited from")

`NavProps.itemRef`

***

### items?[​](#items "Direct link to items?")

> `optional` **items**: [`RsTabItem`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/RsTabItem)\[]

Items for the tab.

***

### itemScope?[​](#itemscope "Direct link to itemScope?")

> `optional` **itemScope**: `boolean`

#### Inherited from[​](#inherited-from-87 "Direct link to Inherited from")

`NavProps.itemScope`

***

### itemType?[​](#itemtype "Direct link to itemType?")

> `optional` **itemType**: `string`

#### Inherited from[​](#inherited-from-88 "Direct link to Inherited from")

`NavProps.itemType`

***

### justified?[​](#justified "Direct link to justified?")

> `optional` **justified**: `boolean`

Whether the Nav component is justified.

#### Inherited from[​](#inherited-from-89 "Direct link to Inherited from")

`NavProps.justified`

***

### lang?[​](#lang "Direct link to lang?")

> `optional` **lang**: `string`

#### Inherited from[​](#inherited-from-90 "Direct link to Inherited from")

`NavProps.lang`

***

### nonce?[​](#nonce "Direct link to nonce?")

> `optional` **nonce**: `string`

#### Inherited from[​](#inherited-from-91 "Direct link to Inherited from")

`NavProps.nonce`

***

### onAbort?[​](#onabort "Direct link to onAbort?")

> `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-92 "Direct link to Inherited from")

`NavProps.onAbort`

***

### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?")

> `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-93 "Direct link to Inherited from")

`NavProps.onAbortCapture`

***

### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?")

> `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-94 "Direct link to Inherited from")

`NavProps.onAnimationEnd`

***

### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?")

> `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-95 "Direct link to Inherited from")

`NavProps.onAnimationEndCapture`

***

### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?")

> `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-96 "Direct link to Inherited from")

`NavProps.onAnimationIteration`

***

### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?")

> `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-97 "Direct link to Inherited from")

`NavProps.onAnimationIterationCapture`

***

### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?")

> `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-98 "Direct link to Inherited from")

`NavProps.onAnimationStart`

***

### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?")

> `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-99 "Direct link to Inherited from")

`NavProps.onAnimationStartCapture`

***

### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?")

> `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-100 "Direct link to Inherited from")

`NavProps.onAuxClick`

***

### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?")

> `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-101 "Direct link to Inherited from")

`NavProps.onAuxClickCapture`

***

### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?")

> `optional` **onBeforeInput**: `InputEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-102 "Direct link to Inherited from")

`NavProps.onBeforeInput`

***

### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?")

> `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-103 "Direct link to Inherited from")

`NavProps.onBeforeInputCapture`

***

### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?")

> `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-104 "Direct link to Inherited from")

`NavProps.onBeforeToggle`

***

### onBlur?[​](#onblur "Direct link to onBlur?")

> `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-105 "Direct link to Inherited from")

`NavProps.onBlur`

***

### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?")

> `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-106 "Direct link to Inherited from")

`NavProps.onBlurCapture`

***

### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?")

> `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-107 "Direct link to Inherited from")

`NavProps.onCanPlay`

***

### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?")

> `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-108 "Direct link to Inherited from")

`NavProps.onCanPlayCapture`

***

### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?")

> `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-109 "Direct link to Inherited from")

`NavProps.onCanPlayThrough`

***

### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?")

> `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-110 "Direct link to Inherited from")

`NavProps.onCanPlayThroughCapture`

***

### onChange?[​](#onchange "Direct link to onChange?")

> `optional` **onChange**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-111 "Direct link to Inherited from")

`NavProps.onChange`

***

### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?")

> `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-112 "Direct link to Inherited from")

`NavProps.onChangeCapture`

***

### onClick?[​](#onclick "Direct link to onClick?")

> `optional` **onClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-113 "Direct link to Inherited from")

`NavProps.onClick`

***

### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?")

> `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-114 "Direct link to Inherited from")

`NavProps.onClickCapture`

***

### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?")

> `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-115 "Direct link to Inherited from")

`NavProps.onCompositionEnd`

***

### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?")

> `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-116 "Direct link to Inherited from")

`NavProps.onCompositionEndCapture`

***

### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?")

> `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-117 "Direct link to Inherited from")

`NavProps.onCompositionStart`

***

### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?")

> `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-118 "Direct link to Inherited from")

`NavProps.onCompositionStartCapture`

***

### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?")

> `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-119 "Direct link to Inherited from")

`NavProps.onCompositionUpdate`

***

### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?")

> `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-120 "Direct link to Inherited from")

`NavProps.onCompositionUpdateCapture`

***

### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?")

> `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-121 "Direct link to Inherited from")

`NavProps.onContextMenu`

***

### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?")

> `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-122 "Direct link to Inherited from")

`NavProps.onContextMenuCapture`

***

### onCopy?[​](#oncopy "Direct link to onCopy?")

> `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-123 "Direct link to Inherited from")

`NavProps.onCopy`

***

### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?")

> `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-124 "Direct link to Inherited from")

`NavProps.onCopyCapture`

***

### onCut?[​](#oncut "Direct link to onCut?")

> `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-125 "Direct link to Inherited from")

`NavProps.onCut`

***

### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?")

> `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-126 "Direct link to Inherited from")

`NavProps.onCutCapture`

***

### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?")

> `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-127 "Direct link to Inherited from")

`NavProps.onDoubleClick`

***

### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?")

> `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-128 "Direct link to Inherited from")

`NavProps.onDoubleClickCapture`

***

### onDrag?[​](#ondrag "Direct link to onDrag?")

> `optional` **onDrag**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-129 "Direct link to Inherited from")

`NavProps.onDrag`

***

### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?")

> `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-130 "Direct link to Inherited from")

`NavProps.onDragCapture`

***

### onDragEnd?[​](#ondragend "Direct link to onDragEnd?")

> `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-131 "Direct link to Inherited from")

`NavProps.onDragEnd`

***

### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?")

> `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-132 "Direct link to Inherited from")

`NavProps.onDragEndCapture`

***

### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?")

> `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-133 "Direct link to Inherited from")

`NavProps.onDragEnter`

***

### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?")

> `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-134 "Direct link to Inherited from")

`NavProps.onDragEnterCapture`

***

### onDragExit?[​](#ondragexit "Direct link to onDragExit?")

> `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-135 "Direct link to Inherited from")

`NavProps.onDragExit`

***

### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?")

> `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-136 "Direct link to Inherited from")

`NavProps.onDragExitCapture`

***

### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?")

> `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-137 "Direct link to Inherited from")

`NavProps.onDragLeave`

***

### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?")

> `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-138 "Direct link to Inherited from")

`NavProps.onDragLeaveCapture`

***

### onDragOver?[​](#ondragover "Direct link to onDragOver?")

> `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-139 "Direct link to Inherited from")

`NavProps.onDragOver`

***

### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?")

> `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-140 "Direct link to Inherited from")

`NavProps.onDragOverCapture`

***

### onDragStart?[​](#ondragstart "Direct link to onDragStart?")

> `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-141 "Direct link to Inherited from")

`NavProps.onDragStart`

***

### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?")

> `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-142 "Direct link to Inherited from")

`NavProps.onDragStartCapture`

***

### onDrop?[​](#ondrop "Direct link to onDrop?")

> `optional` **onDrop**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-143 "Direct link to Inherited from")

`NavProps.onDrop`

***

### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?")

> `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-144 "Direct link to Inherited from")

`NavProps.onDropCapture`

***

### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?")

> `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-145 "Direct link to Inherited from")

`NavProps.onDurationChange`

***

### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?")

> `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-146 "Direct link to Inherited from")

`NavProps.onDurationChangeCapture`

***

### onEmptied?[​](#onemptied "Direct link to onEmptied?")

> `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-147 "Direct link to Inherited from")

`NavProps.onEmptied`

***

### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?")

> `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-148 "Direct link to Inherited from")

`NavProps.onEmptiedCapture`

***

### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?")

> `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-149 "Direct link to Inherited from")

`NavProps.onEncrypted`

***

### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?")

> `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-150 "Direct link to Inherited from")

`NavProps.onEncryptedCapture`

***

### onEnded?[​](#onended "Direct link to onEnded?")

> `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-151 "Direct link to Inherited from")

`NavProps.onEnded`

***

### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?")

> `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-152 "Direct link to Inherited from")

`NavProps.onEndedCapture`

***

### onError?[​](#onerror "Direct link to onError?")

> `optional` **onError**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-153 "Direct link to Inherited from")

`NavProps.onError`

***

### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?")

> `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-154 "Direct link to Inherited from")

`NavProps.onErrorCapture`

***

### onFocus?[​](#onfocus "Direct link to onFocus?")

> `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-155 "Direct link to Inherited from")

`NavProps.onFocus`

***

### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?")

> `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-156 "Direct link to Inherited from")

`NavProps.onFocusCapture`

***

### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?")

> `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-157 "Direct link to Inherited from")

`NavProps.onGotPointerCapture`

***

### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?")

> `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-158 "Direct link to Inherited from")

`NavProps.onGotPointerCaptureCapture`

***

### onInput?[​](#oninput "Direct link to onInput?")

> `optional` **onInput**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-159 "Direct link to Inherited from")

`NavProps.onInput`

***

### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?")

> `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-160 "Direct link to Inherited from")

`NavProps.onInputCapture`

***

### onInvalid?[​](#oninvalid "Direct link to onInvalid?")

> `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-161 "Direct link to Inherited from")

`NavProps.onInvalid`

***

### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?")

> `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-162 "Direct link to Inherited from")

`NavProps.onInvalidCapture`

***

### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?")

> `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-163 "Direct link to Inherited from")

`NavProps.onKeyDown`

***

### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?")

> `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-164 "Direct link to Inherited from")

`NavProps.onKeyDownCapture`

***

### ~~onKeyPress?~~[​](#onkeypress "Direct link to onkeypress")

> `optional` **onKeyPress**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-2 "Direct link to Deprecated")

Use `onKeyUp` or `onKeyDown` instead

#### Inherited from[​](#inherited-from-165 "Direct link to Inherited from")

`NavProps.onKeyPress`

***

### ~~onKeyPressCapture?~~[​](#onkeypresscapture "Direct link to onkeypresscapture")

> `optional` **onKeyPressCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Deprecated[​](#deprecated-3 "Direct link to Deprecated")

Use `onKeyUpCapture` or `onKeyDownCapture` instead

#### Inherited from[​](#inherited-from-166 "Direct link to Inherited from")

`NavProps.onKeyPressCapture`

***

### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?")

> `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-167 "Direct link to Inherited from")

`NavProps.onKeyUp`

***

### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?")

> `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-168 "Direct link to Inherited from")

`NavProps.onKeyUpCapture`

***

### onLoad?[​](#onload "Direct link to onLoad?")

> `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-169 "Direct link to Inherited from")

`NavProps.onLoad`

***

### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?")

> `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-170 "Direct link to Inherited from")

`NavProps.onLoadCapture`

***

### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?")

> `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-171 "Direct link to Inherited from")

`NavProps.onLoadedData`

***

### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?")

> `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-172 "Direct link to Inherited from")

`NavProps.onLoadedDataCapture`

***

### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?")

> `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-173 "Direct link to Inherited from")

`NavProps.onLoadedMetadata`

***

### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?")

> `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-174 "Direct link to Inherited from")

`NavProps.onLoadedMetadataCapture`

***

### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?")

> `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-175 "Direct link to Inherited from")

`NavProps.onLoadStart`

***

### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?")

> `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-176 "Direct link to Inherited from")

`NavProps.onLoadStartCapture`

***

### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?")

> `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-177 "Direct link to Inherited from")

`NavProps.onLostPointerCapture`

***

### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?")

> `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-178 "Direct link to Inherited from")

`NavProps.onLostPointerCaptureCapture`

***

### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?")

> `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-179 "Direct link to Inherited from")

`NavProps.onMouseDown`

***

### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?")

> `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-180 "Direct link to Inherited from")

`NavProps.onMouseDownCapture`

***

### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?")

> `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-181 "Direct link to Inherited from")

`NavProps.onMouseEnter`

***

### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?")

> `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-182 "Direct link to Inherited from")

`NavProps.onMouseLeave`

***

### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?")

> `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-183 "Direct link to Inherited from")

`NavProps.onMouseMove`

***

### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?")

> `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-184 "Direct link to Inherited from")

`NavProps.onMouseMoveCapture`

***

### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?")

> `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-185 "Direct link to Inherited from")

`NavProps.onMouseOut`

***

### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?")

> `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-186 "Direct link to Inherited from")

`NavProps.onMouseOutCapture`

***

### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?")

> `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-187 "Direct link to Inherited from")

`NavProps.onMouseOver`

***

### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?")

> `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-188 "Direct link to Inherited from")

`NavProps.onMouseOverCapture`

***

### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?")

> `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-189 "Direct link to Inherited from")

`NavProps.onMouseUp`

***

### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?")

> `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-190 "Direct link to Inherited from")

`NavProps.onMouseUpCapture`

***

### onPaste?[​](#onpaste "Direct link to onPaste?")

> `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-191 "Direct link to Inherited from")

`NavProps.onPaste`

***

### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?")

> `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-192 "Direct link to Inherited from")

`NavProps.onPasteCapture`

***

### onPause?[​](#onpause "Direct link to onPause?")

> `optional` **onPause**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-193 "Direct link to Inherited from")

`NavProps.onPause`

***

### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?")

> `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-194 "Direct link to Inherited from")

`NavProps.onPauseCapture`

***

### onPlay?[​](#onplay "Direct link to onPlay?")

> `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-195 "Direct link to Inherited from")

`NavProps.onPlay`

***

### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?")

> `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-196 "Direct link to Inherited from")

`NavProps.onPlayCapture`

***

### onPlaying?[​](#onplaying "Direct link to onPlaying?")

> `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-197 "Direct link to Inherited from")

`NavProps.onPlaying`

***

### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?")

> `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-198 "Direct link to Inherited from")

`NavProps.onPlayingCapture`

***

### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?")

> `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-199 "Direct link to Inherited from")

`NavProps.onPointerCancel`

***

### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?")

> `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-200 "Direct link to Inherited from")

`NavProps.onPointerCancelCapture`

***

### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?")

> `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-201 "Direct link to Inherited from")

`NavProps.onPointerDown`

***

### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?")

> `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-202 "Direct link to Inherited from")

`NavProps.onPointerDownCapture`

***

### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?")

> `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-203 "Direct link to Inherited from")

`NavProps.onPointerEnter`

***

### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?")

> `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-204 "Direct link to Inherited from")

`NavProps.onPointerLeave`

***

### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?")

> `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-205 "Direct link to Inherited from")

`NavProps.onPointerMove`

***

### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?")

> `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-206 "Direct link to Inherited from")

`NavProps.onPointerMoveCapture`

***

### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?")

> `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-207 "Direct link to Inherited from")

`NavProps.onPointerOut`

***

### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?")

> `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-208 "Direct link to Inherited from")

`NavProps.onPointerOutCapture`

***

### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?")

> `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-209 "Direct link to Inherited from")

`NavProps.onPointerOver`

***

### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?")

> `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-210 "Direct link to Inherited from")

`NavProps.onPointerOverCapture`

***

### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?")

> `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-211 "Direct link to Inherited from")

`NavProps.onPointerUp`

***

### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?")

> `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-212 "Direct link to Inherited from")

`NavProps.onPointerUpCapture`

***

### onProgress?[​](#onprogress "Direct link to onProgress?")

> `optional` **onProgress**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-213 "Direct link to Inherited from")

`NavProps.onProgress`

***

### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?")

> `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-214 "Direct link to Inherited from")

`NavProps.onProgressCapture`

***

### onRateChange?[​](#onratechange "Direct link to onRateChange?")

> `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-215 "Direct link to Inherited from")

`NavProps.onRateChange`

***

### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?")

> `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-216 "Direct link to Inherited from")

`NavProps.onRateChangeCapture`

***

### onReset?[​](#onreset "Direct link to onReset?")

> `optional` **onReset**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-217 "Direct link to Inherited from")

`NavProps.onReset`

***

### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?")

> `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-218 "Direct link to Inherited from")

`NavProps.onResetCapture`

***

### onScroll?[​](#onscroll "Direct link to onScroll?")

> `optional` **onScroll**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-219 "Direct link to Inherited from")

`NavProps.onScroll`

***

### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?")

> `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-220 "Direct link to Inherited from")

`NavProps.onScrollCapture`

***

### onScrollEnd?[​](#onscrollend "Direct link to onScrollEnd?")

> `optional` **onScrollEnd**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-221 "Direct link to Inherited from")

`NavProps.onScrollEnd`

***

### onScrollEndCapture?[​](#onscrollendcapture "Direct link to onScrollEndCapture?")

> `optional` **onScrollEndCapture**: `UIEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-222 "Direct link to Inherited from")

`NavProps.onScrollEndCapture`

***

### onSeeked?[​](#onseeked "Direct link to onSeeked?")

> `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-223 "Direct link to Inherited from")

`NavProps.onSeeked`

***

### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?")

> `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-224 "Direct link to Inherited from")

`NavProps.onSeekedCapture`

***

### onSeeking?[​](#onseeking "Direct link to onSeeking?")

> `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-225 "Direct link to Inherited from")

`NavProps.onSeeking`

***

### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?")

> `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-226 "Direct link to Inherited from")

`NavProps.onSeekingCapture`

***

### onSelect()?[​](#onselect "Direct link to onSelect()?")

> `optional` **onSelect**: (`eventKey`, `event`) => `void`

Event handler for selecting a Nav item.

#### Parameters[​](#parameters "Direct link to Parameters")

##### eventKey[​](#eventkey "Direct link to eventKey")

`any`

##### event[​](#event "Direct link to event")

`SyntheticEvent`

#### Returns[​](#returns "Direct link to Returns")

`void`

#### Inherited from[​](#inherited-from-227 "Direct link to Inherited from")

`NavProps.onSelect`

***

### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?")

> `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-228 "Direct link to Inherited from")

`NavProps.onSelectCapture`

***

### onStalled?[​](#onstalled "Direct link to onStalled?")

> `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-229 "Direct link to Inherited from")

`NavProps.onStalled`

***

### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?")

> `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-230 "Direct link to Inherited from")

`NavProps.onStalledCapture`

***

### onSubmit?[​](#onsubmit "Direct link to onSubmit?")

> `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-231 "Direct link to Inherited from")

`NavProps.onSubmit`

***

### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?")

> `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-232 "Direct link to Inherited from")

`NavProps.onSubmitCapture`

***

### onSuspend?[​](#onsuspend "Direct link to onSuspend?")

> `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-233 "Direct link to Inherited from")

`NavProps.onSuspend`

***

### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?")

> `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-234 "Direct link to Inherited from")

`NavProps.onSuspendCapture`

***

### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?")

> `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-235 "Direct link to Inherited from")

`NavProps.onTimeUpdate`

***

### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?")

> `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-236 "Direct link to Inherited from")

`NavProps.onTimeUpdateCapture`

***

### onToggle?[​](#ontoggle "Direct link to onToggle?")

> `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-237 "Direct link to Inherited from")

`NavProps.onToggle`

***

### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?")

> `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-238 "Direct link to Inherited from")

`NavProps.onTouchCancel`

***

### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?")

> `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-239 "Direct link to Inherited from")

`NavProps.onTouchCancelCapture`

***

### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?")

> `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-240 "Direct link to Inherited from")

`NavProps.onTouchEnd`

***

### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?")

> `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-241 "Direct link to Inherited from")

`NavProps.onTouchEndCapture`

***

### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?")

> `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-242 "Direct link to Inherited from")

`NavProps.onTouchMove`

***

### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?")

> `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-243 "Direct link to Inherited from")

`NavProps.onTouchMoveCapture`

***

### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?")

> `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-244 "Direct link to Inherited from")

`NavProps.onTouchStart`

***

### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?")

> `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-245 "Direct link to Inherited from")

`NavProps.onTouchStartCapture`

***

### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?")

> `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-246 "Direct link to Inherited from")

`NavProps.onTransitionCancel`

***

### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?")

> `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-247 "Direct link to Inherited from")

`NavProps.onTransitionCancelCapture`

***

### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?")

> `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-248 "Direct link to Inherited from")

`NavProps.onTransitionEnd`

***

### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?")

> `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-249 "Direct link to Inherited from")

`NavProps.onTransitionEndCapture`

***

### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?")

> `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-250 "Direct link to Inherited from")

`NavProps.onTransitionRun`

***

### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?")

> `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-251 "Direct link to Inherited from")

`NavProps.onTransitionRunCapture`

***

### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?")

> `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-252 "Direct link to Inherited from")

`NavProps.onTransitionStart`

***

### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?")

> `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-253 "Direct link to Inherited from")

`NavProps.onTransitionStartCapture`

***

### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?")

> `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-254 "Direct link to Inherited from")

`NavProps.onVolumeChange`

***

### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?")

> `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-255 "Direct link to Inherited from")

`NavProps.onVolumeChangeCapture`

***

### onWaiting?[​](#onwaiting "Direct link to onWaiting?")

> `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-256 "Direct link to Inherited from")

`NavProps.onWaiting`

***

### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?")

> `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-257 "Direct link to Inherited from")

`NavProps.onWaitingCapture`

***

### onWheel?[​](#onwheel "Direct link to onWheel?")

> `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-258 "Direct link to Inherited from")

`NavProps.onWheel`

***

### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?")

> `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`>

#### Inherited from[​](#inherited-from-259 "Direct link to Inherited from")

`NavProps.onWheelCapture`

***

### pane[​](#pane "Direct link to pane")

> **pane**: `ReactNode`

Pane content for the tab.

***

### part?[​](#part "Direct link to part?")

> `optional` **part**: `string`

#### See[​](#see-33 "Direct link to See")

<https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/part>

#### Inherited from[​](#inherited-from-260 "Direct link to Inherited from")

`NavProps.part`

***

### popover?[​](#popover "Direct link to popover?")

> `optional` **popover**: `""` | `"hint"` | `"auto"` | `"manual"`

#### Inherited from[​](#inherited-from-261 "Direct link to Inherited from")

`NavProps.popover`

***

### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?")

> `optional` **popoverTarget**: `string`

#### Inherited from[​](#inherited-from-262 "Direct link to Inherited from")

`NavProps.popoverTarget`

***

### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?")

> `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"`

#### Inherited from[​](#inherited-from-263 "Direct link to Inherited from")

`NavProps.popoverTargetAction`

***

### prefix?[​](#prefix "Direct link to prefix?")

> `optional` **prefix**: `string`

#### Inherited from[​](#inherited-from-264 "Direct link to Inherited from")

`NavProps.prefix`

***

### property?[​](#property "Direct link to property?")

> `optional` **property**: `string`

#### Inherited from[​](#inherited-from-265 "Direct link to Inherited from")

`NavProps.property`

***

### pullRight?[​](#pullright "Direct link to pullRight?")

> `optional` **pullRight**: `boolean`

Whether the Nav component is pulled to the right.

#### Inherited from[​](#inherited-from-266 "Direct link to Inherited from")

`NavProps.pullRight`

***

### radioGroup?[​](#radiogroup "Direct link to radioGroup?")

> `optional` **radioGroup**: `string`

#### Inherited from[​](#inherited-from-267 "Direct link to Inherited from")

`NavProps.radioGroup`

***

### rel?[​](#rel "Direct link to rel?")

> `optional` **rel**: `string`

#### Inherited from[​](#inherited-from-268 "Direct link to Inherited from")

`NavProps.rel`

***

### resource?[​](#resource "Direct link to resource?")

> `optional` **resource**: `string`

#### Inherited from[​](#inherited-from-269 "Direct link to Inherited from")

`NavProps.resource`

***

### results?[​](#results "Direct link to results?")

> `optional` **results**: `number`

#### Inherited from[​](#inherited-from-270 "Direct link to Inherited from")

`NavProps.results`

***

### rev?[​](#rev "Direct link to rev?")

> `optional` **rev**: `string`

#### Inherited from[​](#inherited-from-271 "Direct link to Inherited from")

`NavProps.rev`

***

### reversed?[​](#reversed "Direct link to reversed?")

> `optional` **reversed**: `boolean`

Whether the Nav component is reversed.

#### Inherited from[​](#inherited-from-272 "Direct link to Inherited from")

`NavProps.reversed`

***

### role?[​](#role "Direct link to role?")

> `optional` **role**: `AriaRole`

#### Inherited from[​](#inherited-from-273 "Direct link to Inherited from")

`NavProps.role`

***

### security?[​](#security "Direct link to security?")

> `optional` **security**: `string`

#### Inherited from[​](#inherited-from-274 "Direct link to Inherited from")

`NavProps.security`

***

### showNavigation?[​](#shownavigation "Direct link to showNavigation?")

> `optional` **showNavigation**: `boolean`

Whether to show navigation.

***

### slot?[​](#slot "Direct link to slot?")

> `optional` **slot**: `string`

#### Inherited from[​](#inherited-from-275 "Direct link to Inherited from")

`NavProps.slot`

***

### spellCheck?[​](#spellcheck "Direct link to spellCheck?")

> `optional` **spellCheck**: `Booleanish`

#### Inherited from[​](#inherited-from-276 "Direct link to Inherited from")

`NavProps.spellCheck`

***

### style?[​](#style "Direct link to style?")

> `optional` **style**: `CSSProperties`

Additional style

#### Inherited from[​](#inherited-from-277 "Direct link to Inherited from")

`NavProps.style`

***

### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?")

> `optional` **suppressContentEditableWarning**: `boolean`

#### Inherited from[​](#inherited-from-278 "Direct link to Inherited from")

`NavProps.suppressContentEditableWarning`

***

### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?")

> `optional` **suppressHydrationWarning**: `boolean`

#### Inherited from[​](#inherited-from-279 "Direct link to Inherited from")

`NavProps.suppressHydrationWarning`

***

### tabIndex?[​](#tabindex "Direct link to tabIndex?")

> `optional` **tabIndex**: `number`

#### Inherited from[​](#inherited-from-280 "Direct link to Inherited from")

`NavProps.tabIndex`

***

### title?[​](#title "Direct link to title?")

> `optional` **title**: `string`

#### Inherited from[​](#inherited-from-281 "Direct link to Inherited from")

`NavProps.title`

***

### translate?[​](#translate "Direct link to translate?")

> `optional` **translate**: `"yes"` | `"no"`

#### Inherited from[​](#inherited-from-282 "Direct link to Inherited from")

`NavProps.translate`

***

### typeof?[​](#typeof "Direct link to typeof?")

> `optional` **typeof**: `string`

#### Inherited from[​](#inherited-from-283 "Direct link to Inherited from")

`NavProps.typeof`

***

### unselectable?[​](#unselectable "Direct link to unselectable?")

> `optional` **unselectable**: `"off"` | `"on"`

#### Inherited from[​](#inherited-from-284 "Direct link to Inherited from")

`NavProps.unselectable`

***

### vertical?[​](#vertical "Direct link to vertical?")

> `optional` **vertical**: `boolean`

Whether the Nav component is vertical.

#### Inherited from[​](#inherited-from-285 "Direct link to Inherited from")

`NavProps.vertical`

***

### vocab?[​](#vocab "Direct link to vocab?")

> `optional` **vocab**: `string`

#### Inherited from[​](#inherited-from-286 "Direct link to Inherited from")

`NavProps.vocab`


---

# Interface: RsTagPickerProps

Props for the RsTagPicker component.

## Extends[​](#extends "Direct link to Extends")

* `TagPickerProps`

## Properties[​](#properties "Direct link to Properties")

### appearance?[​](#appearance "Direct link to appearance?")

> `optional` **appearance**: `PickerAppearance`

A picker can have different appearances.

#### Inherited from[​](#inherited-from "Direct link to Inherited from")

`TagPickerProps.appearance`

***

### as?[​](#as "Direct link to as?")

> `optional` **as**: `ElementType`<`any`, keyof IntrinsicElements>

You can use a custom element for this component

#### Inherited from[​](#inherited-from-1 "Direct link to Inherited from")

`TagPickerProps.as`

***

### block?[​](#block "Direct link to block?")

> `optional` **block**: `boolean`

Format picker to appear inside a content block

#### Inherited from[​](#inherited-from-2 "Direct link to Inherited from")

`TagPickerProps.block`

***

### cacheData?[​](#cachedata "Direct link to cacheData?")

> `optional` **cacheData**: `InputItemDataType`<`any`>\[]

Option to cache value when searching asynchronously

#### Inherited from[​](#inherited-from-3 "Direct link to Inherited from")

`TagPickerProps.cacheData`

***

### caretAs?[​](#caretas "Direct link to caretAs?")

> `optional` **caretAs**: `ElementType`<`any`, keyof IntrinsicElements>

Custom caret component

#### Inherited from[​](#inherited-from-4 "Direct link to Inherited from")

`TagPickerProps.caretAs`

***

### children?[​](#children "Direct link to children?")

> `optional` **children**: `ReactNode`

Primary content

#### Inherited from[​](#inherited-from-5 "Direct link to Inherited from")

`TagPickerProps.children`

***

### childrenKey?[​](#childrenkey "Direct link to childrenKey?")

> `optional` **childrenKey**: `string`

The key to use for setting the children in the data.

#### Default[​](#default "Direct link to Default")

```
children
```

#### Inherited from[​](#inherited-from-6 "Direct link to Inherited from")

`TagPickerProps.childrenKey`

***

### className?[​](#classname "Direct link to className?")

> `optional` **className**: `string`

Additional classes

#### Inherited from[​](#inherited-from-7 "Direct link to Inherited from")

`TagPickerProps.className`

***

### classPrefix?[​](#classprefix "Direct link to classPrefix?")

> `optional` **classPrefix**: `string`

The prefix of the component CSS class

#### Inherited from[​](#inherited-from-8 "Direct link to Inherited from")

`TagPickerProps.classPrefix`

***

### cleanable?[​](#cleanable "Direct link to cleanable?")

> `optional` **cleanable**: `boolean`

A picker that can clear values

#### Inherited from[​](#inherited-from-9 "Direct link to Inherited from")

`TagPickerProps.cleanable`

***

### container?[​](#container "Direct link to container?")

> `optional` **container**: `HTMLElement` | () => `HTMLElement`

Sets the rendering container

#### Inherited from[​](#inherited-from-10 "Direct link to Inherited from")

`TagPickerProps.container`

***

### containerPadding?[​](#containerpadding "Direct link to containerPadding?")

> `optional` **containerPadding**: `number`

Set the padding of the container.

#### Inherited from[​](#inherited-from-11 "Direct link to Inherited from")

`TagPickerProps.containerPadding`

***

### creatable?[​](#creatable "Direct link to creatable?")

> `optional` **creatable**: `boolean`

Settings can create new options

#### Inherited from[​](#inherited-from-12 "Direct link to Inherited from")

`TagPickerProps.creatable`

***

### data[​](#data "Direct link to data")

> **data**: `InputItemDataType`<`string` | `number`>\[]

The data of the component.

#### Inherited from[​](#inherited-from-13 "Direct link to Inherited from")

`TagPickerProps.data`

***

### defaultOpen?[​](#defaultopen "Direct link to defaultOpen?")

> `optional` **defaultOpen**: `boolean`

Initial open menu

#### Inherited from[​](#inherited-from-14 "Direct link to Inherited from")

`TagPickerProps.defaultOpen`

***

### defaultValue?[​](#defaultvalue "Direct link to defaultValue?")

> `optional` **defaultValue**: `any`

Initial value

#### Inherited from[​](#inherited-from-15 "Direct link to Inherited from")

`TagPickerProps.defaultValue`

***

### disabled?[​](#disabled "Direct link to disabled?")

> `optional` **disabled**: `boolean`

A picker can show it is currently unable to be interacted with

#### Inherited from[​](#inherited-from-16 "Direct link to Inher