# This is the documentation for the FormEngine packages. > It contains detailed manuals, components, and utilities for creating user interfaces. ## documentation Form Builder is a client-side library for creating web forms. The library allows you to map a form from JSON to a dynamic HTML form and send - [Form Builder](https://formengine.io/documentation/index.md): Form Builder is a client-side library for creating web forms. The library allows you to map a form from JSON to a dynamic HTML form and send ### search - [Search the documentation](https://formengine.io/documentation/search.md) ### actions Overview - [Actions](https://formengine.io/documentation/actions.md): Overview ### 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 - [Adaptive layout](https://formengine.io/documentation/adaptive-layout.md): Form Builder allows you to set different styles for different layouts. In the "For device" drop-down menu on the "Style" tab, you ### adding-wasm-component Guide to connecting the WASM component - [Adding WASM component](https://formengine.io/documentation/adding-wasm-component.md): Guide to connecting the WASM component ### api-reference Packages - [API reference](https://formengine.io/documentation/api-reference.md): Packages - [@react-form-builder/components-fast-qr](https://formengine.io/documentation/api-reference/@react-form-builder/components-fast-qr.md): Interfaces - [Interface: FastQrProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-fast-qr/interfaces/FastQrProps.md): The Fast QR component properties. - [Variable: fastQrComponent](https://formengine.io/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponent.md): const fastQrComponent: Definer\ = fastQr - [Variable: fastQrComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponentsDescriptions.md): const fastQrComponentsDescriptions: Record\ - [Variable: fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrEnUsComponentsDescriptions.md): fastQrEnUsComponentsDescriptions: object - [Variable: fastQrModel](https://formengine.io/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrModel.md): const fastQrModel: Model\ - [@react-form-builder/components-google-map](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map.md): Interfaces - [Function: toAddress()](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/functions/toAddress.md): toAddress(components): Address - [Interface: GoogleMapProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/interfaces/GoogleMapProps.md): Props for the GoogleMap component. - [Type Alias: Address](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address.md): Address = object - [Type Alias: MapMarker](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker.md): MapMarker = object - [Variable: googleMapComponent](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponent.md): const googleMapComponent: Definer\ = googleMap - [Variable: googleMapComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponentsDescriptions.md): const googleMapComponentsDescriptions: Record\ - [Variable: googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapEnUsComponentsDescriptions.md): googleMapEnUsComponentsDescriptions: object - [Variable: googleMapModel](https://formengine.io/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapModel.md): const googleMapModel: Model\ - [@react-form-builder/components-rich-text](https://formengine.io/documentation/api-reference/@react-form-builder/components-rich-text.md): Interfaces - [Interface: RichTextEditorProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rich-text/interfaces/RichTextEditorProps.md): The Rich text editor component properties. - [Variable: richTextComponent](https://formengine.io/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextComponent.md): const richTextComponent: Definer\ = richTextEditor - [Variable: richTextEditorComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorComponentsDescriptions.md): const richTextEditorComponentsDescriptions: Record\ - [Variable: richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorEnUsComponentsDescriptions.md): richTextEditorEnUsComponentsDescriptions: object - [Variable: richTextModel](https://formengine.io/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextModel.md): const richTextModel: Model\ - [@react-form-builder/components-rsuite](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite.md): Interfaces - [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/functions/formEngineRsuiteCssLoader.md): formEngineRsuiteCssLoader(): Promise\ - [Function: ltrCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/functions/ltrCssLoader.md): ltrCssLoader(): Promise\ - [Function: RsLocalizationWrapper()](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/functions/RsLocalizationWrapper.md): RsLocalizationWrapper(props): Element - [Function: rtlCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/functions/rtlCssLoader.md): rtlCssLoader(): Promise\ - [Interface: RsAutoCompleteProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsAutoCompleteProps.md): The properties of the RsAutoComplete component. - [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbItemProps.md): Props for a single breadcrumb item. - [Interface: RsBreadcrumbProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbProps.md): Props for the RsBreadcrumb component. - [Interface: RsCalendarProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCalendarProps.md): Props for the RsCalendar component. - [Interface: RsCardProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCardProps.md): Props for the RsCard component. - [Interface: RsContainerProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsContainerProps.md): Props for the RsContainer component. - [Interface: RsDatePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDatePickerProps.md): Props for the RsDatePicker component. - [Interface: RsDropdownProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDropdownProps.md): Props for the RsDropdown component. - [Interface: RsErrorMessageProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps.md): The properties of RsErrorMessage component. - [Interface: RsHeaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsHeaderProps.md): Props for the RsHeader component. - [Interface: RsImageProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsImageProps.md): Props for the RsImage component. - [Interface: RsInputProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsInputProps.md): Props for the RsInput component. - [Interface: RsLabelProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLabelProps.md): Props for the RsLabel component. - [Interface: RsLinkProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLinkProps.md): Props for the RsLink component. - [Interface: RsMenuProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsMenuProps.md): Props for the RsMenu component. - [Interface: RsModalLayoutProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalLayoutProps.md): Props for the RsModalLayout component. - [Interface: RsModalProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalProps.md): Props for the RsModal component. - [Interface: RsNumberFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsNumberFormatProps.md): Props for the RsNumberFormat component. - [Interface: RsPatternFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsPatternFormatProps.md): Props for the RsPatternFormat component. - [Interface: RsRadioGroupProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsRadioGroupProps.md): Props for the RsRadioGroup component. - [Interface: RsSearchProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsSearchProps.md): Props for the RsSearch component. - [Interface: RsStaticContentProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsStaticContentProps.md): Props for the RsStaticContent component. - [Interface: RsTabProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTabProps.md): Props for the RsTab component. - [Interface: RsTagPickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTagPickerProps.md): Props for the RsTagPicker component. - [Interface: RsTextAreaProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTextAreaProps.md): Props for the RsTextArea component. - [Interface: RsTimePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTimePickerProps.md): Props for the RsTimePicker component. - [Interface: RsTooltipProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps.md): The properties of RsTooltip component. - [Interface: RsUploaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsUploaderProps.md): Props for the RsUploader component. - [Interface: RsWizardProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardProps.md): Props for the RsWizard component. - [Interface: RsWizardStepProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardStepProps.md): Props for the RsWizardStep component. - [Type Alias: LoadCallback()](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadCallback.md): LoadCallback = (newData) => void - [Type Alias: LoadDataHandler()](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadDataHandler.md): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => object - [Type Alias: MenuItem](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/MenuItem.md): MenuItem = object - [Type Alias: RsTabItem](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/RsTabItem.md): RsTabItem = object - [Variable: builderViewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/builderViewWithCss.md): const builderViewWithCss: BuilderView - [Variable: models](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/models.md): const models: Model\[] - [Variable: rsAutoComplete](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsAutoComplete.md): const rsAutoComplete: Definer\ - [Variable: rsBreadcrumb](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsBreadcrumb.md): const rsBreadcrumb: Definer\ - [Variable: rsButton](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsButton.md): const rsButton: Definer\ - [Variable: rsCalendar](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCalendar.md): const rsCalendar: Definer\ - [Variable: rsCard](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCard.md): const rsCard: Definer\ - [Variable: rsCheckbox](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCheckbox.md): const rsCheckbox: Definer\\> - [Variable: rsContainer](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsContainer.md): const rsContainer: Definer\\> - [Variable: rsDatePicker](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDatePicker.md): const rsDatePicker: Definer\ - [Variable: rsDivider](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDivider.md): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\> - [Variable: rsDropdown](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDropdown.md): const rsDropdown: Definer\ - [Variable: rsErrorMessage](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsErrorMessage.md): const rsErrorMessage: Definer\ - [Variable: rsHeader](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsHeader.md): const rsHeader: Definer\ - [Variable: rsImage](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsImage.md): const rsImage: Definer\ - [Variable: rsInput](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsInput.md): const rsInput: Definer\ - [Variable: rsLabel](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLabel.md): const rsLabel: Definer\ - [Variable: rsLink](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLink.md): const rsLink: Definer\ - [Variable: rsMenu](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMenu.md): const rsMenu: Definer\ - [Variable: rsMessage](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMessage.md): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\> - [Variable: rsModal](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModal.md): const rsModal: Definer\ - [Variable: rsModalLayout](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModalLayout.md): const rsModalLayout: Definer\ - [Variable: rsNumberFormat](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsNumberFormat.md): const rsNumberFormat: Definer\ - [Variable: rsPatternFormat](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPatternFormat.md): const rsPatternFormat: Definer\ - [Variable: rsPlaceholderGraph](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGraph.md): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\> - [Variable: rsPlaceholderGrid](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGrid.md): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\> - [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderParagraph.md): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\> - [Variable: rsProgressCircle](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressCircle.md): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\> - [Variable: rsProgressLine](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressLine.md): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\> - [Variable: rsRadioGroup](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsRadioGroup.md): const rsRadioGroup: Definer\ - [Variable: rsSearch](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsSearch.md): const rsSearch: Definer\ - [Variable: rsStaticContent](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsStaticContent.md): const rsStaticContent: Definer\ - [Variable: rsTab](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTab.md): const rsTab: Definer\ - [Variable: rsTagPicker](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTagPicker.md): const rsTagPicker: Definer\ - [Variable: rsTextArea](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTextArea.md): const rsTextArea: Definer\ - [Variable: rsTimePicker](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTimePicker.md): const rsTimePicker: Definer\ - [Variable: rsToggle](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsToggle.md): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\> - [Variable: rsTooltip](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTooltip.md): const rsTooltip: Definer\ - [Variable: rSuiteComponents](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponents.md): const rSuiteComponents: Definer\[] = [] - [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponentsDescriptions.md): const rSuiteComponentsDescriptions: Record\ - [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteEnUsComponentsDescriptions.md): rSuiteEnUsComponentsDescriptions: object - [Variable: rsUploader](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsUploader.md): const rsUploader: Definer\ - [Variable: rsWizard](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizard.md): const rsWizard: Definer\ - [Variable: rsWizardStep](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizardStep.md): const rsWizardStep: Definer\ & HTMLAttributes\\> - [Variable: view](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/view.md): const view: View - [Variable: viewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/components-rsuite/variables/viewWithCss.md): const viewWithCss: View - [@react-form-builder/components-signature](https://formengine.io/documentation/api-reference/@react-form-builder/components-signature.md): Interfaces - [Interface: SignatureProps](https://formengine.io/documentation/api-reference/@react-form-builder/components-signature/interfaces/SignatureProps.md): The Signature pad properties. - [Variable: signatureComponent](https://formengine.io/documentation/api-reference/@react-form-builder/components-signature/variables/signatureComponent.md): const signatureComponent: Definer\ = signature - [Variable: signatureComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-signature/variables/signatureComponentsDescriptions.md): const signatureComponentsDescriptions: Record\ - [Variable: signatureEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/components-signature/variables/signatureEnUsComponentsDescriptions.md): signatureEnUsComponentsDescriptions: object - [Variable: signatureModel](https://formengine.io/documentation/api-reference/@react-form-builder/components-signature/variables/signatureModel.md): const signatureModel: Model\ - [@react-form-builder/core](https://formengine.io/documentation/api-reference/@react-form-builder/core.md): Enumerations - [Class: ActionDefinition](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition.md): Represents the definition of an action. - [Class: ActionEventArgs](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ActionEventArgs.md): Arguments passed to the event handler. - [Class: Annotation](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/Annotation.md): Basic metadata class for a React component property for the form builder. - [Class: AnnotationBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/AnnotationBuilder.md): The builder class to define the metadata property of the form builder component. - [Class: ArrayBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ArrayBuilder.md): The builder class to define the metadata property of the form builder component. - [Class: BaseBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/BaseBuilder.md): The base builder class to define the metadata property of the form builder component. - [Class: BuilderOptions](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/BuilderOptions.md): Options for building an annotation. - [Class: BuilderView](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/BuilderView.md): Represents all the metadata of the form builder components. - [Class: CalculableResult](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/CalculableResult.md): Calculable result. - [Class: ComponentData](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ComponentData.md): 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/api-reference/@react-form-builder/core/classes/ComponentDataEvents.md): Represents a class that holds events related to component data. - [Class: ComponentKeyChangedEventArgs](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ComponentKeyChangedEventArgs.md): Represents the event argument for the event when the component key changes. - [Class: ComponentState](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ComponentState.md): Calculates all the properties of the form view component. - [Class: ComponentStore](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ComponentStore.md): Component settings for serialization in JSON. - [Class: ContainerAnnotation](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ContainerAnnotation.md): Metadata for the component container property for the form builder. - [Class: DataValidator](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/DataValidator.md): Binds all parts of the validation and performs the validation. - [Class: EventAnnotation](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/EventAnnotation.md): Metadata for the component event property for the form builder. - [Class: Form](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/Form.md): Represents a form that is rendered in Viewer or edited in Builder. - [Class: FormViewerPropsStore](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/FormViewerPropsStore.md): Represents the props passed to the FormViewer Store. Internal use only. - [Class: Language](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/Language.md): The language to localize the form builder. - [Class: LocalizationStore](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/LocalizationStore.md): Observable storage of localization. Internal use only. - [Class: Meta](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/Meta.md): Component metadata for the form builder. - [Class: Model](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/Model.md): Represents component metadata for the form viewer. - [Class: ModuleAnnotation](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/ModuleAnnotation.md): Metadata for a component property that is not a property of the component itself, - [Class: NodeAnnotationBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/NodeAnnotationBuilder.md): The builder class to define the node metadata property. - [Class: OneOfBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/OneOfBuilder.md): The builder class to define the metadata property of the form builder component. - [Class: PropertyAnnotation](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/PropertyAnnotation.md): Metadata for the component property for the form builder. - [Class: abstract QuantifierBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/QuantifierBuilder.md): The abstract builder class to define the metadata property of the form builder component. - [Class: SomeOfBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/SomeOfBuilder.md): The builder class to define the metadata property of the form builder component. - [Class: Store](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/Store.md): The form viewer settings. Internal use only. - [Class: StyleAnnotation](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/StyleAnnotation.md): Metadata for the component style property for the form builder. - [Class: SyncEvent](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/SyncEvent.md): Represents a synchronous event that can be subscribed to and invoked. Internal use only. - [Class: TemplateField](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/TemplateField.md): The field with the form data, contains the value of the nested form. Internal use only. - [Class: TypedBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/TypedBuilder.md): The builder class to define the metadata property of the form builder component. - [Class: View](https://formengine.io/documentation/api-reference/@react-form-builder/core/classes/View.md): Represents all the metadata of the form viewer components. - [Enumeration: BiDi](https://formengine.io/documentation/api-reference/@react-form-builder/core/enumerations/BiDi.md): The enumeration of bidirectional text layout types. - [Enumeration: PersistedFormVersion](https://formengine.io/documentation/api-reference/@react-form-builder/core/enumerations/PersistedFormVersion.md): The version of the saved form. - [Function: buildForm()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/buildForm.md): buildForm(options?): IFormJsonBuilder - [Function: calculatePropertyValue()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/calculatePropertyValue.md): calculatePropertyValue(componentProperty, formViewerData): CalculableResult - [Function: camelCase()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/camelCase.md): camelCase(input): string - [Function: checkSlotCondition()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/checkSlotCondition.md): checkSlotCondition(childStore, parentProps): any - [Function: cloneDeep()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/cloneDeep.md): cloneDeep\(value, weakMap): T - [Function: ComponentTree()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/ComponentTree.md): ComponentTree(props): Element - [Function: createActionValuesFromObject()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/createActionValuesFromObject.md): createActionValuesFromObject(obj): ActionValues - [Function: createNonNullableContext()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/createNonNullableContext.md): createNonNullableContext\(name, defaultValue): \[() => T, Provider\, Context\\] - [Function: createProperty()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/createProperty.md): createProperty(editor): AnnotationBuilder\ - [Function: debounce()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/debounce.md): debounce\(fn, wait): (...args) => void \| ReturnType\ - [Function: findLanguage()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/findLanguage.md): findLanguage(languages, language): undefined \| Language - [Function: findTreeElementDepth()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/findTreeElementDepth.md): findTreeElementDepth\(value, element?, depth?): undefined \| number - [Function: fn()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/fn.md): fn(fnDescriptionBegin, fnDescriptionEnd): TypedBuilder\ - [Function: forwardRef()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/forwardRef.md): forwardRef\(render): ForwardRefExoticComponent\ \| ForwardRefExoticComponent\ & RefAttributes\\> - [Function: generateTemplateTypeName()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/generateTemplateTypeName.md): generateTemplateTypeName(name): string - [Function: generateUniqueName()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/generateUniqueName.md): generateUniqueName(prefix, existingNames): string - [Function: getChildren()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getChildren.md): getChildren(data, componentTreeItem, componentProps): Record\ - [Function: getDefault()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getDefault.md): getDefault(annotations): Readonly\\> - [Function: getDefaultCss()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getDefaultCss.md): getDefaultCss(annotations): Readonly\\> - [Function: getEditableFormData()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getEditableFormData.md): getEditableFormData(form): Record\ - [Function: getFluentCompatibleId()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getFluentCompatibleId.md): getFluentCompatibleId(rawId): string - [Function: getFluentData()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getFluentData.md): getFluentData(data, parentKey): Record\ - [Function: getKey()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getKey.md): getKey(): string - [Function: getValidatorPropertyBlockType()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/getValidatorPropertyBlockType.md): getValidatorPropertyBlockType(ruleKey): string - [Function: groupBy()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/groupBy.md): groupBy\(array, predicate): Record\ - [Function: isContainer()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isContainer.md): isContainer(value): value is ContainerAnnotation - [Function: isEmpty()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isEmpty.md): isEmpty(value): boolean - [Function: isEqual()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isEqual.md): isEqual\(a, b): boolean - [Function: isEqualWith()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isEqualWith.md): isEqualWith(a, b, customizer?): boolean - [Function: isFunctionalProperty()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isFunctionalProperty.md): isFunctionalProperty(componentProperty?): boolean - [Function: isLocalizedProperty()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isLocalizedProperty.md): isLocalizedProperty(componentProperty?): boolean - [Function: isNull()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isNull.md): isNull(value): value is null - [Function: isNumber()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isNumber.md): isNumber(value): value is number - [Function: isObject()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isObject.md): isObject(value): value is Record - [Function: isPromise()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isPromise.md): isPromise\(value): value is Promise - [Function: isProperty()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isProperty.md): isProperty(value): value is PropertyAnnotation - [Function: isString()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isString.md): isString(value): value is string - [Function: isUndefined()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isUndefined.md): isUndefined(value): value is undefined - [Function: isValidatorPropertyBlockType()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/isValidatorPropertyBlockType.md): isValidatorPropertyBlockType(type): boolean - [Function: loadResource()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/loadResource.md): loadResource(id, href, rel): Promise\ - [Function: merge()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/merge.md): merge\(target, ...sources): T - [Function: nameAutorun()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/nameAutorun.md): nameAutorun(owner, name, params): string - [Function: namedObserver()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/namedObserver.md): namedObserver\(displayName, component): T - [Function: nameObservable()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/nameObservable.md): nameObservable(owner, params): string - [Function: needRender()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/needRender.md): needRender(componentStore, formData): boolean - [Function: SDiv()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/SDiv.md): SDiv(props): Element - [Function: startCase()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/startCase.md): startCase(input): string - [Function: SuppressResizeObserverErrors()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/SuppressResizeObserverErrors.md): SuppressResizeObserverErrors(props): Element - [Function: testFluentLocalization()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/testFluentLocalization.md): testFluentLocalization(request): CalculableResult - [Function: toArray()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/toArray.md): toArray\(annotations?, setup?): Annotation[] - [Function: toLabeledValues()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/toLabeledValues.md): toLabeledValues(items, upper): LabeledValue[] - [Function: toUpper()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/toUpper.md): toUpper(input): string - [Function: treeForEach()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/treeForEach.md): treeForEach\(tree, fn): void - [Function: uniqueId()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/uniqueId.md): uniqueId(prefix): string - [Function: unloadResource()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/unloadResource.md): unloadResource(id): void - [Function: upperFirst()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/upperFirst.md): upperFirst(input): string - [Function: useAriaAttributes()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useAriaAttributes.md): useAriaAttributes(options): object - [Function: useAriaAttributesIds()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useAriaAttributesIds.md): useAriaAttributesIds(options): AriaAttributesIds - [Function: useAriaErrorMessage()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useAriaErrorMessage.md): useAriaErrorMessage(): object - [Function: useAriaInvalid()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useAriaInvalid.md): useAriaInvalid(): object - [Function: useBuilderComponent()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useBuilderComponent.md): useBuilderComponent\(builderComponent, viewerComponent): ComponentType\ - [Function: useBuilderValue()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useBuilderValue.md): useBuilderValue\(value, builderValue): T - [Function: useDisposable()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useDisposable.md): useDisposable\(factory): undefined \| T - [Function: useErrorMessage()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useErrorMessage.md): useErrorMessage(): undefined \| string - [Function: useErrorModel()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useErrorModel.md): useErrorModel(): Model\ - [Function: useMobxConfig()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useMobxConfig.md): useMobxConfig(): void - [Function: useModalComponentData()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useModalComponentData.md): useModalComponentData(parentComponentData, modalType): ComponentData - [Function: useModalType()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useModalType.md): useModalType(): undefined \| string - [Function: useTooltipType()](https://formengine.io/documentation/api-reference/@react-form-builder/core/functions/useTooltipType.md): useTooltipType(): undefined \| string - [Interface: BaseCompilationResult](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/BaseCompilationResult.md): The result of compiling of anything. Internal use only. - [Interface: BuilderComponent](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/BuilderComponent.md): Description of the React component that connects to the form builder. - [Interface: ComponentField](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/ComponentField.md): Describes the field of the component. - [Interface: ComponentMetadataEventListeners](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/ComponentMetadataEventListeners.md): Component metadata event listeners. - [Interface: ComponentProperty](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/ComponentProperty.md): The value of the component property. - [Interface: ComponentTreeProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/ComponentTreeProps.md): Properties of a form component tree element. - [Interface: Definer](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md): The builder class to define the metadata of the form builder component. - [Interface: ErrorWrapperProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps.md): Properties of the React component that wraps the form view component and displays validation errors. - [Interface: Field](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/Field.md): Field with the form data. - [Interface: FormViewerProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps.md): Form viewer React component properties. - [Interface: FormViewerWrapperComponentProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerWrapperComponentProps.md): 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/api-reference/@react-form-builder/core/interfaces/IComponentBuilder.md): Interface for configuring a specific component within the form. - [Interface: IComponentDataFactory](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IComponentDataFactory.md): The factory for creating ComponentData instances. Internal use only. - [Interface: IComponentState](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IComponentState.md): Calculates all the properties of the form view component. - [Interface: IDataRootProvider](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IDataRootProvider.md): Provides the root component for the data in the component tree. - [Interface: IEventHandlerBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IEventHandlerBuilder.md): Interface for defining event handlers for a component. - [Interface: IFormData](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IFormData.md): The interface for accessing the form data. - [Interface: IFormJsonBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IFormJsonBuilder.md): Interface for building a form JSON. - [Interface: IFormViewer](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IFormViewer.md): The form viewer settings interface. - [Interface: InternalErrorProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/InternalErrorProps.md): React component properties that display an internal form view error. Internal use only. - [Interface: IStore](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IStore.md): The form viewer settings interface. - [Interface: IValidationBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/IValidationBuilder.md): Interface for defining validation rules for a component. - [Interface: LabeledValue](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/LabeledValue.md): The element with the value and the label. - [Interface: PersistedForm](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/PersistedForm.md): The format for saving a form designed in Form Builder. - [Interface: ScreenProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/ScreenProps.md): Properties of the root component of the form. Internal use only. - [Interface: SuppressResizeObserverErrorsProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/SuppressResizeObserverErrorsProps.md): Represents the props for the SuppressResizeObserverErrors component. Internal use only. - [Interface: TemplateProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/TemplateProps.md): The template component properties. - [Interface: WrapperProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps.md): React wrapper component properties. - [Type Alias: ActionData](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ActionData.md): ActionData = object - [Type Alias: ActionEventHandler()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ActionEventHandler.md): ActionEventHandler = (e) => void \| Promise\ - [Type Alias: ActionHandler()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ActionHandler.md): ActionHandler\ = (e, params) => void \| Promise\ - [Type Alias: ActionParameters](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ActionParameters.md): ActionParameters = Record\ - [Type Alias: ActionsInitializer()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ActionsInitializer.md): ActionsInitializer = (props, def) => Record\ - [Type Alias: ActionType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ActionType.md): ActionType = "common" \| "code" \| "custom" - [Type Alias: ActionValues](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ActionValues.md): ActionValues = Record\ - [Type Alias: Annotations](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Annotations.md): Annotations\ = \{ \[key in keyof T\]: BaseBuilder\ \| undefined \} - [Type Alias: AnnotationType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/AnnotationType.md): AnnotationType = "Property" \| "Container" \| "Event" \| "Module" \| "Style" - [Type Alias: Arguments](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Arguments.md): Arguments = Record\ - [Type Alias: ArgumentValue](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ArgumentValue.md): ArgumentValue = PrimitiveArgumentValue \| FunctionArgumentValue - [Type Alias: AriaAttributesIds](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesIds.md): AriaAttributesIds = Record\, string\> - [Type Alias: AriaAttributesOptions](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/AriaAttributesOptions.md): AriaAttributesOptions = object - [Type Alias: BoundValueSchema](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/BoundValueSchema.md): BoundValueSchema = object - [Type Alias: BuilderMode](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderMode.md): BuilderMode = "builder" \| "viewer" - [Type Alias: BuilderSetup](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/BuilderSetup.md): BuilderSetup = Partial\ - [Type Alias: CellInfo](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/CellInfo.md): CellInfo = object - [Type Alias: ComponentDescription](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDescription.md): ComponentDescription = I18nItem & object - [Type Alias: ComponentDeviceStyle](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentDeviceStyle.md): ComponentDeviceStyle = object - [Type Alias: ComponentFeature](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeature.md): ComponentFeature = object - [Type Alias: ComponentFeatures](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentFeatures.md): ComponentFeatures = Record\ - [Type Alias: ComponentKey](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKey.md): ComponentKey = string - [Type Alias: ComponentKind](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentKind.md): ComponentKind = "container" \| "component" \| "template" \| "repeater" - [Type Alias: ComponentLibraryDescription](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription.md): ComponentLibraryDescription = object - [Type Alias: ComponentLocalizer()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLocalizer.md): ComponentLocalizer = (componentStore, language) => Record\ - [Type Alias: ComponentPropertiesContext](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertiesContext.md): ComponentPropertiesContext = object - [Type Alias: ComponentPropertyBindType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyBindType.md): ComponentPropertyBindType = "single" \| "array" - [Type Alias: ComponentPropertyComputeType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyComputeType.md): ComponentPropertyComputeType = "function" \| "localization" - [Type Alias: ComponentPropertyName](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropertyName.md): ComponentPropertyName = string - [Type Alias: ComponentPropsLocalization](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentPropsLocalization.md): ComponentPropsLocalization = Record\ - [Type Alias: ComponentRole](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentRole.md): ComponentRole = "label" \| "tooltip" \| "error-message" \| "modal" \| string - [Type Alias: ComponentsLocalization](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentsLocalization.md): ComponentsLocalization = Record\ - [Type Alias: ComponentStateFactory()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStateFactory.md): ComponentStateFactory = (data, store, context?) => IComponentState - [Type Alias: ComponentStoreLocalizer()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStoreLocalizer.md): ComponentStoreLocalizer = (componentStore) => Record\ - [Type Alias: ComponentStyle](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentStyle.md): ComponentStyle = object - [Type Alias: ComputeChildren()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ComputeChildren.md): ComputeChildren = (componentData, componentProps) => Record\ - [Type Alias: Css](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Css.md): Css = object - [Type Alias: CssLoaderType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/CssLoaderType.md): CssLoaderType = BiDi \| "common" - [Type Alias: CssPart](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/CssPart.md): CssPart = "css" \| "wrapperCss" - [Type Alias: CustomActions](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/CustomActions.md): CustomActions = Record\ - [Type Alias: CustomValidationRules](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRules.md): CustomValidationRules = Record\ - [Type Alias: CustomValidationRuleSettings](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/CustomValidationRuleSettings.md): CustomValidationRuleSettings = object - [Type Alias: DataBindingType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/DataBindingType.md): DataBindingType = "oneWay" \| "twoWay" \| "none" - [Type Alias: DataKeyType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/DataKeyType.md): DataKeyType = string \| number \| symbol - [Type Alias: DefineActionHelper()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/DefineActionHelper.md): DefineActionHelper = \(name, func, params?, description?) => ActionDefinition - [Type Alias: DefinerData](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/DefinerData.md): DefinerData\ = object - [Type Alias: Device](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Device.md): Device = "any" \| "desktop" \| "mobile" \| "tablet" - [Type Alias: DeviceStyle](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/DeviceStyle.md): DeviceStyle = object - [Type Alias: EditorType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/EditorType.md): EditorType = string - [Type Alias: ErrorMap](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMap.md): ErrorMap = object - [Type Alias: ErrorMessageLocalizer()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ErrorMessageLocalizer.md): ErrorMessageLocalizer = (value) => string[] \| undefined - [Type Alias: EventName](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/EventName.md): EventName = string - [Type Alias: FieldType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FieldType.md): FieldType = "simple" \| "template" \| "repeater" - [Type Alias: FirstParameter](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FirstParameter.md): FirstParameter\ = Parameters\\[0\] - [Type Alias: FormOptions](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FormOptions.md): FormOptions = object - [Type Alias: FormValidator()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidator.md): FormValidator = (data) => Promise\ \| undefined\> - [Type Alias: FormValidators](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FormValidators.md): FormValidators = FormValidator[] - [Type Alias: FormViewerValidationRules](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerValidationRules.md): FormViewerValidationRules = object - [Type Alias: FormViewerWrapper](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FormViewerWrapper.md): FormViewerWrapper = ComponentType\ - [Type Alias: Func()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Func.md): Func = (...arg) => void \| Promise\ - [Type Alias: FunctionArgumentValue](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/FunctionArgumentValue.md): FunctionArgumentValue = object - [Type Alias: GetInitialDataFn()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/GetInitialDataFn.md): GetInitialDataFn = () => unknown - [Type Alias: HtmlAttribute](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/HtmlAttribute.md): HtmlAttribute = Record\ - [Type Alias: I18nItem](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/I18nItem.md): I18nItem = object - [Type Alias: IDisposable](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/IDisposable.md): IDisposable = object - [Type Alias: InsertRestrictionFn()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/InsertRestrictionFn.md): InsertRestrictionFn = (self, target, slot?) => boolean - [Type Alias: LanguageFullCode](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode.md): LanguageFullCode = ` $-${string} ` - [Type Alias: LocalizationTestRequest](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationTestRequest.md): LocalizationTestRequest = object - [Type Alias: LocalizationType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationType.md): LocalizationType = "component" \| "tooltip" \| "modal" \| string - [Type Alias: LocalizationValue](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/LocalizationValue.md): LocalizationValue = Record\ - [Type Alias: MessagesMap](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/MessagesMap.md): MessagesMap = Record\\> - [Type Alias: ModalComponentStore](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ModalComponentStore.md): ModalComponentStore = object - [Type Alias: NamedActionDefinition](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/NamedActionDefinition.md): NamedActionDefinition = object - [Type Alias: NodeEditorType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/NodeEditorType.md): NodeEditorType = "node" \| "string" - [Type Alias: ParameterDefinition](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterDefinition.md): ParameterDefinition\ = \[PropertyKey\, ParameterType\] - [Type Alias: ParameterName](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterName.md): ParameterName = string - [Type Alias: ParameterType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ParameterType.md): ParameterType = "string" \| "number" \| "boolean" \| "function" - [Type Alias: PreAnnotation](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/PreAnnotation.md): PreAnnotation = Partial\\> & Pick\ - [Type Alias: PrimitiveArgumentValue](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/PrimitiveArgumentValue.md): PrimitiveArgumentValue = string \| number \| boolean - [Type Alias: PropertyBlockType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/PropertyBlockType.md): PropertyBlockType = "component" \| "tooltip" \| "modal" \| string - [Type Alias: PropertyKey](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/PropertyKey.md): PropertyKey\ = keyof T & string - [Type Alias: ReactProperty](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ReactProperty.md): ReactProperty = object - [Type Alias: Rel](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Rel.md): Rel = "stylesheet" \| string - [Type Alias: ResolvedValidator()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ResolvedValidator.md): ResolvedValidator = (value, store, getFormData?) => Promise\ - [Type Alias: RuleValidator()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidator.md): RuleValidator\ = (value, store, args?, formData?) => RuleValidatorResult \| Promise\ - [Type Alias: RuleValidatorResult](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/RuleValidatorResult.md): RuleValidatorResult = string \| boolean - [Type Alias: SchemaResolver()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaResolver.md): SchemaResolver\ = (value) => ResolvedValidator - [Type Alias: SchemaType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaType.md): SchemaType = keyof SchemaTypeMap - [Type Alias: SchemaTypeMap](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/SchemaTypeMap.md): SchemaTypeMap = object - [Type Alias: SetInitialDataFn()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/SetInitialDataFn.md): SetInitialDataFn = (key, value) => void - [Type Alias: Setter()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Setter.md): Setter\ = (value) => void - [Type Alias: SyncEventHandler()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/SyncEventHandler.md): SyncEventHandler\ = (source, eventArgs) => void - [Type Alias: TypedLocalization](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/TypedLocalization.md): TypedLocalization = Partial\\> - [Type Alias: ValidationMessages](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationMessages.md): ValidationMessages = string] \| [MessagesMap \| undefined - [Type Alias: ValidationResult](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationResult.md): ValidationResult = object - [Type Alias: ValidationRule](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRule.md): ValidationRule = object - [Type Alias: ValidationRuleParameter](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleParameter.md): ValidationRuleParameter = object - [Type Alias: ValidationRuleSet](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSet.md): ValidationRuleSet = Record\ - [Type Alias: ValidationRuleSettings](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidationRuleSettings.md): ValidationRuleSettings = object - [Type Alias: ValidatorFactory()](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorFactory.md): ValidatorFactory\ = (args) => RuleValidator - [Type Alias: Validators](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/Validators.md): Validators = Partial\\> - [Type Alias: ValidatorType](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ValidatorType.md): ValidatorType = "internal" \| "custom" - [Type Alias: ViewMode](https://formengine.io/documentation/api-reference/@react-form-builder/core/type-aliases/ViewMode.md): ViewMode = "desktop" \| "mobile" \| "tablet" - [Variable: ActionEventArgsDeclaration](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/ActionEventArgsDeclaration.md): 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/api-reference/@react-form-builder/core/variables/array.md): const array: ArrayBuilder\ - [Variable: AsyncFunction](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/AsyncFunction.md): const AsyncFunction: Function - [Variable: boolean](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/boolean.md): const boolean: TypedBuilder\ - [Variable: BuilderModeProvider](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/BuilderModeProvider.md): BuilderModeProvider: Provider\ - [Variable: CellInfoContextProvider](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/CellInfoContextProvider.md): CellInfoContextProvider: Provider\ - [Variable: cfComponentIsPreset](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfComponentIsPreset.md): const cfComponentIsPreset: "component-is-preset" = 'component-is-preset' - [Variable: cfDisableActionEditors](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableActionEditors.md): const cfDisableActionEditors: "disable-action-editors" = 'disable-action-editors' - [Variable: cfDisableAdditionalProperties](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableAdditionalProperties.md): const cfDisableAdditionalProperties: "disable-additional-properties" = 'disable-additional-properties' - [Variable: cfDisableComponentRemove](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableComponentRemove.md): const cfDisableComponentRemove: "disable-component-remove" = 'disable-component-remove' - [Variable: cfDisableMainComponentProperties](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableMainComponentProperties.md): const cfDisableMainComponentProperties: "disable-main-component-properties" = 'disable-main-component-properties' - [Variable: cfDisableStyleProperties](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableStyleProperties.md): const cfDisableStyleProperties: "disable-style-properties" = 'disable-style-properties' - [Variable: cfDisableStyles](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableStyles.md): const cfDisableStyles: "disable-component-styling" = 'disable-component-styling' - [Variable: cfDisableStylesForClassNameEditor](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableStylesForClassNameEditor.md): const cfDisableStylesForClassNameEditor: "disable-styles-for-classname-editor" = 'disable-styles-for-classname-editor' - [Variable: cfDisableTooltipProperties](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableTooltipProperties.md): const cfDisableTooltipProperties: "disable-tooltip-properties" = 'disable-tooltip-properties' - [Variable: cfDisableWrapperStyles](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfDisableWrapperStyles.md): const cfDisableWrapperStyles: "disable-component-wrapper-styling" = 'disable-component-wrapper-styling' - [Variable: cfEnableInlineStylesEditor](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfEnableInlineStylesEditor.md): const cfEnableInlineStylesEditor: "enable-inline-styles-editor" = 'enable-inline-styles-editor' - [Variable: cfHideFromComponentPalette](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cfHideFromComponentPalette.md): const cfHideFromComponentPalette: "hide-from-component-palette" = 'hide-from-component-palette' - [Variable: className](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/className.md): const className: Annotation - [Variable: color](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/color.md): const color: TypedBuilder\ - [Variable: commonStyles](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/commonStyles.md): const commonStyles: object - [Variable: ComponentDataProvider](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/ComponentDataProvider.md): ComponentDataProvider: Provider\ - [Variable: containerStyles](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/containerStyles.md): const containerStyles: object - [Variable: coreComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/coreComponentsDescriptions.md): const coreComponentsDescriptions: Record\ - [Variable: createAnnotation()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/createAnnotation.md): const createAnnotation: \(editor) => AnnotationBuilder\ = AnnotationBuilder.create - [Variable: createView()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/createView.md): const createView: (models) => View = View.create - [Variable: cssSize](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/cssSize.md): const cssSize: AnnotationBuilder\ - [Variable: date](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/date.md): const date: TypedBuilder\ - [Variable: DefaultWrapper](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/DefaultWrapper.md): const DefaultWrapper: ForwardRefExoticComponent\ \| ForwardRefExoticComponent\ & RefAttributes\\> - [Variable: define()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/define.md): const define: \(component, displayName?) => Definer\ = Definer.define - [Variable: definePreset()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/definePreset.md): const definePreset: (name, components) => Definer\ = Definer.definePreset - [Variable: DidMountEvent](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/DidMountEvent.md): const DidMountEvent: "onDidMount" = 'onDidMount' - [Variable: disabled](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/disabled.md): const disabled: TypedBuilder\ - [Variable: emotionCache](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/emotionCache.md): const emotionCache: object - [Variable: emptyComponentStore](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/emptyComponentStore.md): const emptyComponentStore: ComponentStore - [Variable: errorMessageModel](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/errorMessageModel.md): const errorMessageModel: Model\ - [Variable: event](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/event.md): const event: AnnotationBuilder\ - [Variable: FormViewer()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/FormViewer.md): const FormViewer: (props) => Element - [Variable: globalDefaultLanguage](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/globalDefaultLanguage.md): const globalDefaultLanguage: Language - [Variable: htmlAttributes](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/htmlAttributes.md): const htmlAttributes: AnnotationBuilder\ - [Variable: IFormDataDeclaration](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/IFormDataDeclaration.md): 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. @default true\n \/\n reset(clearInitialData? void\n\n /\\\n \ Clears the form data.\n \ @param clearInitialData if true, then also clear the initial data. @default 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/api-reference/@react-form-builder/core/variables/internalErrorModel.md): const internalErrorModel: Model\ - [Variable: isUniqueKey](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/isUniqueKey.md): const isUniqueKey: RuleValidator\ - [Variable: key](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/key.md): const key: Annotation - [Variable: KeySymbol](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/KeySymbol.md): const KeySymbol: typeof KeySymbol - [Variable: node](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/node.md): const node: NodeAnnotationBuilder\ - [Variable: nodeArray](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/nodeArray.md): const nodeArray: NodeAnnotationBuilder\ - [Variable: number](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/number.md): const number: TypedBuilder\ - [Variable: object](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/object.md): const object: TypedBuilder\ - [Variable: oneOf()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/oneOf.md): const oneOf: \(...values) => OneOfBuilder\ - [Variable: readOnly](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/readOnly.md): const readOnly: TypedBuilder\ - [Variable: renderWhen](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/renderWhen.md): const renderWhen: TypedBuilder\ - [Variable: screenModel](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/screenModel.md): const screenModel: Model\ & RefAttributes\\> - [Variable: size](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/size.md): const size: TypedBuilder\ - [Variable: slotModel](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/slotModel.md): const slotModel: Model\ - [Variable: someOf()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/someOf.md): const someOf: \(...values) => SomeOfBuilder\ - [Variable: StoreContext](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/StoreContext.md): StoreContext: Context\ - [Variable: StoreProvider](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/StoreProvider.md): StoreProvider: Provider\ - [Variable: string](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/string.md): const string: TypedBuilder\ - [Variable: stringNode](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/stringNode.md): const stringNode: NodeAnnotationBuilder\ - [Variable: time](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/time.md): const time: TypedBuilder\ - [Variable: timeFormat](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/timeFormat.md): const timeFormatmmmm:ss' - [Variable: tooltipProps](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/tooltipProps.md): const tooltipProps: AnnotationBuilder\ - [Variable: tooltipType](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/tooltipType.md): const tooltipType: TypedBuilder\ - [Variable: useBuilderMode()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/useBuilderMode.md): useBuilderMode: () => BuilderMode - [Variable: useComponentData()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/useComponentData.md): useComponentData: () => ComponentData - [Variable: useStore()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/useStore.md): useStore: () => Store - [Variable: useViewerProps()](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/useViewerProps.md): useViewerProps: () => T - [Variable: validation](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/validation.md): const validation: AnnotationBuilder\ - [Variable: ViewerPropsProvider](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/ViewerPropsProvider.md): ViewerPropsProvider: Provider\\> - [Variable: WillUnmountEvent](https://formengine.io/documentation/api-reference/@react-form-builder/core/variables/WillUnmountEvent.md): const WillUnmountEvent: "onWillUnmount" = 'onWillUnmount' - [@react-form-builder/designer-bundle](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle.md): Namespaces - [Class: ActionDefinition](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/classes/ActionDefinition.md): Represents the definition of an action. - [Class: Language](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/classes/Language.md): The language to localize the form builder. - [Function: buildForm()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/functions/buildForm.md): buildForm(options?): IFormJsonBuilder - [Function: createBuilderView()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/functions/createBuilderView.md): createBuilderView(components): BuilderView - [Function: renderFormBuilder()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilder.md): renderFormBuilder(elementId, props): Root - [Function: renderFormBuilderTo()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/functions/renderFormBuilderTo.md): renderFormBuilderTo(container, props): Root - [fastQrComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent.md): Interfaces - [Interface: FastQrProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/interfaces/FastQrProps.md): The Fast QR component properties. - [Variable: fastQrComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrComponent.md): const fastQrComponent: Definer\ = fastQr - [Variable: fastQrComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrComponentsDescriptions.md): const fastQrComponentsDescriptions: Record\ - [Variable: fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrEnUsComponentsDescriptions.md): fastQrEnUsComponentsDescriptions: object - [Variable: fastQrModel](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/fastQrComponent/variables/fastQrModel.md): const fastQrModel: Model\ - [googleMapComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent.md): Interfaces - [Function: toAddress()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/functions/toAddress.md): toAddress(components): Address - [Interface: GoogleMapProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/interfaces/GoogleMapProps.md): Props for the GoogleMap component. - [Type Alias: Address](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/Address.md): Address = object - [Type Alias: MapMarker](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/type-aliases/MapMarker.md): MapMarker = object - [Variable: googleMapComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapComponent.md): const googleMapComponent: Definer\ = googleMap - [Variable: googleMapComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapComponentsDescriptions.md): const googleMapComponentsDescriptions: Record\ - [Variable: googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapEnUsComponentsDescriptions.md): googleMapEnUsComponentsDescriptions: object - [Variable: googleMapModel](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/googleMapComponent/variables/googleMapModel.md): const googleMapModel: Model\ - [richTextComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent.md): Interfaces - [Interface: RichTextEditorProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/interfaces/RichTextEditorProps.md): The Rich text editor component properties. - [Variable: richTextComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextComponent.md): const richTextComponent: Definer\ = richTextEditor - [Variable: richTextEditorComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextEditorComponentsDescriptions.md): const richTextEditorComponentsDescriptions: Record\ - [Variable: richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextEditorEnUsComponentsDescriptions.md): richTextEditorEnUsComponentsDescriptions: object - [Variable: richTextModel](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/richTextComponent/variables/richTextModel.md): const richTextModel: Model\ - [rSuiteComponents](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents.md): Interfaces - [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader.md): formEngineRsuiteCssLoader(): Promise\ - [Function: ltrCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/ltrCssLoader.md): ltrCssLoader(): Promise\ - [Function: RsLocalizationWrapper()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/RsLocalizationWrapper.md): RsLocalizationWrapper(props): Element - [Function: rtlCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/functions/rtlCssLoader.md): rtlCssLoader(): Promise\ - [Interface: RsAutoCompleteProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsAutoCompleteProps.md): The properties of the RsAutoComplete component. - [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps.md): Props for a single breadcrumb item. - [Interface: RsBreadcrumbProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbProps.md): Props for the RsBreadcrumb component. - [Interface: RsCalendarProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsCalendarProps.md): Props for the RsCalendar component. - [Interface: RsCardProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsCardProps.md): Props for the RsCard component. - [Interface: RsContainerProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsContainerProps.md): Props for the RsContainer component. - [Interface: RsDatePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsDatePickerProps.md): Props for the RsDatePicker component. - [Interface: RsDropdownProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsDropdownProps.md): Props for the RsDropdown component. - [Interface: RsErrorMessageProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps.md): The properties of RsErrorMessage component. - [Interface: RsHeaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsHeaderProps.md): Props for the RsHeader component. - [Interface: RsImageProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsImageProps.md): Props for the RsImage component. - [Interface: RsInputProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsInputProps.md): Props for the RsInput component. - [Interface: RsLabelProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsLabelProps.md): Props for the RsLabel component. - [Interface: RsLinkProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsLinkProps.md): Props for the RsLink component. - [Interface: RsMenuProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsMenuProps.md): Props for the RsMenu component. - [Interface: RsModalLayoutProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsModalLayoutProps.md): Props for the RsModalLayout component. - [Interface: RsModalProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsModalProps.md): Props for the RsModal component. - [Interface: RsNumberFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsNumberFormatProps.md): Props for the RsNumberFormat component. - [Interface: RsPatternFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsPatternFormatProps.md): Props for the RsPatternFormat component. - [Interface: RsRadioGroupProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsRadioGroupProps.md): Props for the RsRadioGroup component. - [Interface: RsSearchProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsSearchProps.md): Props for the RsSearch component. - [Interface: RsStaticContentProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsStaticContentProps.md): Props for the RsStaticContent component. - [Interface: RsTabProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTabProps.md): Props for the RsTab component. - [Interface: RsTagPickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTagPickerProps.md): Props for the RsTagPicker component. - [Interface: RsTextAreaProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTextAreaProps.md): Props for the RsTextArea component. - [Interface: RsTimePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTimePickerProps.md): Props for the RsTimePicker component. - [Interface: RsTooltipProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps.md): The properties of RsTooltip component. - [Interface: RsUploaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsUploaderProps.md): Props for the RsUploader component. - [Interface: RsWizardProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardProps.md): Props for the RsWizard component. - [Interface: RsWizardStepProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardStepProps.md): Props for the RsWizardStep component. - [Type Alias: LoadCallback()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadCallback.md): LoadCallback = (newData) => void - [Type Alias: LoadDataHandler()](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/LoadDataHandler.md): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => object - [Type Alias: MenuItem](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/MenuItem.md): MenuItem = object - [Type Alias: RsTabItem](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/type-aliases/RsTabItem.md): RsTabItem = object - [Variable: builderViewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/builderViewWithCss.md): const builderViewWithCss: BuilderView - [Variable: models](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/models.md): const models: Model\[] - [Variable: rsAutoComplete](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsAutoComplete.md): const rsAutoComplete: Definer\ - [Variable: rsBreadcrumb](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsBreadcrumb.md): const rsBreadcrumb: Definer\ - [Variable: rsButton](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsButton.md): const rsButton: Definer\ - [Variable: rsCalendar](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCalendar.md): const rsCalendar: Definer\ - [Variable: rsCard](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCard.md): const rsCard: Definer\ - [Variable: rsCheckbox](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsCheckbox.md): const rsCheckbox: Definer\\> - [Variable: rsContainer](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsContainer.md): const rsContainer: Definer\\> - [Variable: rsDatePicker](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDatePicker.md): const rsDatePicker: Definer\ - [Variable: rsDivider](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDivider.md): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\> - [Variable: rsDropdown](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsDropdown.md): const rsDropdown: Definer\ - [Variable: rsErrorMessage](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsErrorMessage.md): const rsErrorMessage: Definer\ - [Variable: rsHeader](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsHeader.md): const rsHeader: Definer\ - [Variable: rsImage](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsImage.md): const rsImage: Definer\ - [Variable: rsInput](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsInput.md): const rsInput: Definer\ - [Variable: rsLabel](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsLabel.md): const rsLabel: Definer\ - [Variable: rsLink](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsLink.md): const rsLink: Definer\ - [Variable: rsMenu](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsMenu.md): const rsMenu: Definer\ - [Variable: rsMessage](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsMessage.md): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\> - [Variable: rsModal](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsModal.md): const rsModal: Definer\ - [Variable: rsModalLayout](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsModalLayout.md): const rsModalLayout: Definer\ - [Variable: rsNumberFormat](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsNumberFormat.md): const rsNumberFormat: Definer\ - [Variable: rsPatternFormat](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPatternFormat.md): const rsPatternFormat: Definer\ - [Variable: rsPlaceholderGraph](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGraph.md): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\> - [Variable: rsPlaceholderGrid](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGrid.md): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\> - [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderParagraph.md): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\> - [Variable: rsProgressCircle](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsProgressCircle.md): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\> - [Variable: rsProgressLine](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsProgressLine.md): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\> - [Variable: rsRadioGroup](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsRadioGroup.md): const rsRadioGroup: Definer\ - [Variable: rsSearch](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsSearch.md): const rsSearch: Definer\ - [Variable: rsStaticContent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsStaticContent.md): const rsStaticContent: Definer\ - [Variable: rsTab](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTab.md): const rsTab: Definer\ - [Variable: rsTagPicker](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTagPicker.md): const rsTagPicker: Definer\ - [Variable: rsTextArea](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTextArea.md): const rsTextArea: Definer\ - [Variable: rsTimePicker](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTimePicker.md): const rsTimePicker: Definer\ - [Variable: rsToggle](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsToggle.md): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\> - [Variable: rsTooltip](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsTooltip.md): const rsTooltip: Definer\ - [Variable: rSuiteComponents](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponents.md): const rSuiteComponents: Definer\[] = [] - [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponentsDescriptions.md): const rSuiteComponentsDescriptions: Record\ - [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rSuiteEnUsComponentsDescriptions.md): rSuiteEnUsComponentsDescriptions: object - [Variable: rsUploader](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsUploader.md): const rsUploader: Definer\ - [Variable: rsWizard](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsWizard.md): const rsWizard: Definer\ - [Variable: rsWizardStep](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/rsWizardStep.md): const rsWizardStep: Definer\ & HTMLAttributes\\> - [Variable: view](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/view.md): const view: View - [Variable: viewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteComponents/variables/viewWithCss.md): const viewWithCss: View - [rSuiteTableComponents](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents.md): Variables - [Variable: rSuiteTableComponents](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/rSuiteTableComponents.md): const rSuiteTableComponents: Definer\[] = [] - [Variable: rSuiteTableComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/rSuiteTableComponentsDescriptions.md): const rSuiteTableComponentsDescriptions: Record\ - [Variable: rSuiteTableEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/rSuiteTableEnUsComponentsDescriptions.md): rSuiteTableEnUsComponentsDescriptions: object - [Variable: tableModels](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/rSuiteTableComponents/variables/tableModels.md): const tableModels: Model\[] - [signatureComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent.md): Interfaces - [Interface: SignatureProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/interfaces/SignatureProps.md): The Signature pad properties. - [Variable: signatureComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureComponent.md): const signatureComponent: Definer\ = signature - [Variable: signatureComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureComponentsDescriptions.md): const signatureComponentsDescriptions: Record\ - [Variable: signatureEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureEnUsComponentsDescriptions.md): signatureEnUsComponentsDescriptions: object - [Variable: signatureModel](https://formengine.io/documentation/api-reference/@react-form-builder/designer-bundle/namespaces/signatureComponent/variables/signatureModel.md): const signatureModel: Model\ - [@react-form-builder/designer](https://formengine.io/documentation/api-reference/@react-form-builder/designer.md): Enumerations - [Class: BuilderView](https://formengine.io/documentation/api-reference/@react-form-builder/designer/classes/BuilderView.md): Represents all the metadata of the form builder components. - [Class: PresetComponentLocalStorage](https://formengine.io/documentation/api-reference/@react-form-builder/designer/classes/PresetComponentLocalStorage.md): Class for working with the preset components in the local storage. - [Enumeration: Section](https://formengine.io/documentation/api-reference/@react-form-builder/designer/enumerations/Section.md): Component property editor section. - [Function: ActionCell()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/functions/ActionCell.md): ActionCell(props): Element - [Function: CheckCell()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/functions/CheckCell.md): CheckCell(props): Element - [Function: EditableTable()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/functions/EditableTable.md): EditableTable(props): Element - [Function: InputCell()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/functions/InputCell.md): InputCell(props): Element - [Function: makeColumns()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/functions/makeColumns.md): makeColumns(columns): Element[] - [Function: SelectCell()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/functions/SelectCell.md): SelectCell(props): Element - [Interface: ActionCellProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/ActionCellProps.md): The properties of ActionCell component. - [Interface: AnnotationEditorProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/AnnotationEditorProps.md): Props for the AnnotationEditor component. - [Interface: CalculableEditorProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/CalculableEditorProps.md): Represents the props used to edit a calculable property. - [Interface: ColumnDescription](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/ColumnDescription.md): The description of the table column. - [Interface: EditableTableProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/EditableTableProps.md): The React component properties for the EditableTable component. - [Interface: EditableTableState](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/EditableTableState.md): The state of the EditableTable component. - [Interface: FormBuilderProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/FormBuilderProps.md): Properties of the React Form builder component. - [Interface: IFormBuilder](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/IFormBuilder.md): The form builder settings interface. - [Interface: IFormStorage](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/IFormStorage.md): Interface for storing forms in an external storage. - [Interface: InputCellProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/InputCellProps.md): The properties of InputCell component. - [Interface: IPresetComponentOptions](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/IPresetComponentOptions.md): Interface for configuring preset component options. - [Interface: PresetComponent](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/PresetComponent.md): The preset component settings. - [Interface: SelectCellProps](https://formengine.io/documentation/api-reference/@react-form-builder/designer/interfaces/SelectCellProps.md): The properties of SelectCell component. - [Type Alias: ComputePropertiesParameters](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/ComputePropertiesParameters.md): ComputePropertiesParameters = object - [Type Alias: ComputeTypeParams](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/ComputeTypeParams.md): ComputeTypeParams\ = ComputePropertiesParameters\[T\] - [Type Alias: CustomizableKey](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/CustomizableKey.md): CustomizableKey = typeof CustomizableZone extends Set\ ? U : never - [Type Alias: CustomizationMap](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/CustomizationMap.md): CustomizationMap = Partial\\> - [Type Alias: FormBuilderI18n](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/FormBuilderI18n.md): FormBuilderI18n = object - [Type Alias: FormBuilderI18nData](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/FormBuilderI18nData.md): FormBuilderI18nData = object - [Type Alias: FormBuilderTheme](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/FormBuilderTheme.md): FormBuilderTheme = "light" \| "dark" \| "system" - [Type Alias: LocalizationComputeCodeParams](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/LocalizationComputeCodeParams.md): LocalizationComputeCodeParams = object - [Type Alias: Options](https://formengine.io/documentation/api-reference/@react-form-builder/designer/type-aliases/Options.md): Options = object - [Variable: CustomizableZone](https://formengine.io/documentation/api-reference/@react-form-builder/designer/variables/CustomizableZone.md): const CustomizableZone: Set\ - [Variable: FormBuilder()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/variables/FormBuilder.md): const FormBuilder: (props) => Element - [Variable: SCell](https://formengine.io/documentation/api-reference/@react-form-builder/designer/variables/SCell.md): const SCell: StyledComponent\, string \| number\> & RefAttributes\ & object, \{ \}, \{ \}\> - [Variable: useFormBuilder()](https://formengine.io/documentation/api-reference/@react-form-builder/designer/variables/useFormBuilder.md): useFormBuilder: () => IFormBuilder - [@react-form-builder/viewer-bundle-premium](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium.md): Namespaces - [Class: ActionDefinition](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/classes/ActionDefinition.md): Represents the definition of an action. - [Class: Language](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/classes/Language.md): The language to localize the form builder. - [Function: buildForm()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/functions/buildForm.md): buildForm(options?): IFormJsonBuilder - [Function: renderFormViewer()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/functions/renderFormViewer.md): renderFormViewer(elementId, props): Root - [Function: renderFormViewerTo()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/functions/renderFormViewerTo.md): renderFormViewerTo(container, props): Root - [fastQrComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent.md): Interfaces - [Interface: FastQrProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/interfaces/FastQrProps.md): The Fast QR component properties. - [Variable: fastQrComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrComponent.md): const fastQrComponent: Definer\ = fastQr - [Variable: fastQrComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrComponentsDescriptions.md): const fastQrComponentsDescriptions: Record\ - [Variable: fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrEnUsComponentsDescriptions.md): fastQrEnUsComponentsDescriptions: object - [Variable: fastQrModel](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/fastQrComponent/variables/fastQrModel.md): const fastQrModel: Model\ - [googleMapComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent.md): Interfaces - [Function: toAddress()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/functions/toAddress.md): toAddress(components): Address - [Interface: GoogleMapProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/interfaces/GoogleMapProps.md): Props for the GoogleMap component. - [Type Alias: Address](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/type-aliases/Address.md): Address = object - [Type Alias: MapMarker](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/type-aliases/MapMarker.md): MapMarker = object - [Variable: googleMapComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapComponent.md): const googleMapComponent: Definer\ = googleMap - [Variable: googleMapComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapComponentsDescriptions.md): const googleMapComponentsDescriptions: Record\ - [Variable: googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapEnUsComponentsDescriptions.md): googleMapEnUsComponentsDescriptions: object - [Variable: googleMapModel](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/googleMapComponent/variables/googleMapModel.md): const googleMapModel: Model\ - [richTextComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent.md): Interfaces - [Interface: RichTextEditorProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/interfaces/RichTextEditorProps.md): The Rich text editor component properties. - [Variable: richTextComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextComponent.md): const richTextComponent: Definer\ = richTextEditor - [Variable: richTextEditorComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextEditorComponentsDescriptions.md): const richTextEditorComponentsDescriptions: Record\ - [Variable: richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextEditorEnUsComponentsDescriptions.md): richTextEditorEnUsComponentsDescriptions: object - [Variable: richTextModel](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/richTextComponent/variables/richTextModel.md): const richTextModel: Model\ - [rSuiteComponents](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents.md): Interfaces - [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader.md): formEngineRsuiteCssLoader(): Promise\ - [Function: ltrCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/ltrCssLoader.md): ltrCssLoader(): Promise\ - [Function: RsLocalizationWrapper()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/RsLocalizationWrapper.md): RsLocalizationWrapper(props): Element - [Function: rtlCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/functions/rtlCssLoader.md): rtlCssLoader(): Promise\ - [Interface: RsAutoCompleteProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsAutoCompleteProps.md): The properties of the RsAutoComplete component. - [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps.md): Props for a single breadcrumb item. - [Interface: RsBreadcrumbProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsBreadcrumbProps.md): Props for the RsBreadcrumb component. - [Interface: RsCalendarProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsCalendarProps.md): Props for the RsCalendar component. - [Interface: RsCardProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsCardProps.md): Props for the RsCard component. - [Interface: RsContainerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsContainerProps.md): Props for the RsContainer component. - [Interface: RsDatePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsDatePickerProps.md): Props for the RsDatePicker component. - [Interface: RsDropdownProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsDropdownProps.md): Props for the RsDropdown component. - [Interface: RsErrorMessageProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps.md): The properties of RsErrorMessage component. - [Interface: RsHeaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsHeaderProps.md): Props for the RsHeader component. - [Interface: RsImageProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsImageProps.md): Props for the RsImage component. - [Interface: RsInputProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsInputProps.md): Props for the RsInput component. - [Interface: RsLabelProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsLabelProps.md): Props for the RsLabel component. - [Interface: RsLinkProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsLinkProps.md): Props for the RsLink component. - [Interface: RsMenuProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsMenuProps.md): Props for the RsMenu component. - [Interface: RsModalLayoutProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsModalLayoutProps.md): Props for the RsModalLayout component. - [Interface: RsModalProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsModalProps.md): Props for the RsModal component. - [Interface: RsNumberFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsNumberFormatProps.md): Props for the RsNumberFormat component. - [Interface: RsPatternFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsPatternFormatProps.md): Props for the RsPatternFormat component. - [Interface: RsRadioGroupProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsRadioGroupProps.md): Props for the RsRadioGroup component. - [Interface: RsSearchProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsSearchProps.md): Props for the RsSearch component. - [Interface: RsStaticContentProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsStaticContentProps.md): Props for the RsStaticContent component. - [Interface: RsTabProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTabProps.md): Props for the RsTab component. - [Interface: RsTagPickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTagPickerProps.md): Props for the RsTagPicker component. - [Interface: RsTextAreaProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTextAreaProps.md): Props for the RsTextArea component. - [Interface: RsTimePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTimePickerProps.md): Props for the RsTimePicker component. - [Interface: RsTooltipProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsTooltipProps.md): The properties of RsTooltip component. - [Interface: RsUploaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsUploaderProps.md): Props for the RsUploader component. - [Interface: RsWizardProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsWizardProps.md): Props for the RsWizard component. - [Interface: RsWizardStepProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/interfaces/RsWizardStepProps.md): Props for the RsWizardStep component. - [Type Alias: LoadCallback()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/LoadCallback.md): LoadCallback = (newData) => void - [Type Alias: LoadDataHandler()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/LoadDataHandler.md): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => object - [Type Alias: MenuItem](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/MenuItem.md): MenuItem = object - [Type Alias: RsTabItem](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/type-aliases/RsTabItem.md): RsTabItem = object - [Variable: builderViewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/builderViewWithCss.md): const builderViewWithCss: BuilderView - [Variable: models](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/models.md): const models: Model\[] - [Variable: rsAutoComplete](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsAutoComplete.md): const rsAutoComplete: Definer\ - [Variable: rsBreadcrumb](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsBreadcrumb.md): const rsBreadcrumb: Definer\ - [Variable: rsButton](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsButton.md): const rsButton: Definer\ - [Variable: rsCalendar](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsCalendar.md): const rsCalendar: Definer\ - [Variable: rsCard](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsCard.md): const rsCard: Definer\ - [Variable: rsCheckbox](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsCheckbox.md): const rsCheckbox: Definer\\> - [Variable: rsContainer](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsContainer.md): const rsContainer: Definer\\> - [Variable: rsDatePicker](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsDatePicker.md): const rsDatePicker: Definer\ - [Variable: rsDivider](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsDivider.md): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\> - [Variable: rsDropdown](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsDropdown.md): const rsDropdown: Definer\ - [Variable: rsErrorMessage](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsErrorMessage.md): const rsErrorMessage: Definer\ - [Variable: rsHeader](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsHeader.md): const rsHeader: Definer\ - [Variable: rsImage](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsImage.md): const rsImage: Definer\ - [Variable: rsInput](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsInput.md): const rsInput: Definer\ - [Variable: rsLabel](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsLabel.md): const rsLabel: Definer\ - [Variable: rsLink](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsLink.md): const rsLink: Definer\ - [Variable: rsMenu](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsMenu.md): const rsMenu: Definer\ - [Variable: rsMessage](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsMessage.md): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\> - [Variable: rsModal](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsModal.md): const rsModal: Definer\ - [Variable: rsModalLayout](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsModalLayout.md): const rsModalLayout: Definer\ - [Variable: rsNumberFormat](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsNumberFormat.md): const rsNumberFormat: Definer\ - [Variable: rsPatternFormat](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPatternFormat.md): const rsPatternFormat: Definer\ - [Variable: rsPlaceholderGraph](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPlaceholderGraph.md): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\> - [Variable: rsPlaceholderGrid](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPlaceholderGrid.md): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\> - [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsPlaceholderParagraph.md): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\> - [Variable: rsProgressCircle](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsProgressCircle.md): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\> - [Variable: rsProgressLine](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsProgressLine.md): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\> - [Variable: rsRadioGroup](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsRadioGroup.md): const rsRadioGroup: Definer\ - [Variable: rsSearch](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsSearch.md): const rsSearch: Definer\ - [Variable: rsStaticContent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsStaticContent.md): const rsStaticContent: Definer\ - [Variable: rsTab](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTab.md): const rsTab: Definer\ - [Variable: rsTagPicker](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTagPicker.md): const rsTagPicker: Definer\ - [Variable: rsTextArea](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTextArea.md): const rsTextArea: Definer\ - [Variable: rsTimePicker](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTimePicker.md): const rsTimePicker: Definer\ - [Variable: rsToggle](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsToggle.md): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\> - [Variable: rsTooltip](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsTooltip.md): const rsTooltip: Definer\ - [Variable: rSuiteComponents](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rSuiteComponents.md): const rSuiteComponents: Definer\[] = [] - [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rSuiteComponentsDescriptions.md): const rSuiteComponentsDescriptions: Record\ - [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rSuiteEnUsComponentsDescriptions.md): rSuiteEnUsComponentsDescriptions: object - [Variable: rsUploader](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsUploader.md): const rsUploader: Definer\ - [Variable: rsWizard](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsWizard.md): const rsWizard: Definer\ - [Variable: rsWizardStep](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/rsWizardStep.md): const rsWizardStep: Definer\ & HTMLAttributes\\> - [Variable: view](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/view.md): const view: View - [Variable: viewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteComponents/variables/viewWithCss.md): const viewWithCss: View - [rSuiteTableComponents](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents.md): Variables - [Variable: rSuiteTableComponents](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/rSuiteTableComponents.md): const rSuiteTableComponents: Definer\[] = [] - [Variable: rSuiteTableComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/rSuiteTableComponentsDescriptions.md): const rSuiteTableComponentsDescriptions: Record\ - [Variable: rSuiteTableEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/rSuiteTableEnUsComponentsDescriptions.md): rSuiteTableEnUsComponentsDescriptions: object - [Variable: tableModels](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/rSuiteTableComponents/variables/tableModels.md): const tableModels: Model\[] - [signatureComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent.md): Interfaces - [Interface: SignatureProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/interfaces/SignatureProps.md): The Signature pad properties. - [Variable: signatureComponent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureComponent.md): const signatureComponent: Definer\ = signature - [Variable: signatureComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureComponentsDescriptions.md): const signatureComponentsDescriptions: Record\ - [Variable: signatureEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureEnUsComponentsDescriptions.md): signatureEnUsComponentsDescriptions: object - [Variable: signatureModel](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/namespaces/signatureComponent/variables/signatureModel.md): const signatureModel: Model\ - [Variable: createView()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle-premium/variables/createView.md): const createView: (models) => View = View.create - [@react-form-builder/viewer-bundle](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle.md): Namespaces - [Class: ActionDefinition](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/classes/ActionDefinition.md): Represents the definition of an action. - [Class: Language](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/classes/Language.md): The language to localize the form builder. - [Function: buildForm()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/functions/buildForm.md): buildForm(options?): IFormJsonBuilder - [Function: renderFormViewer()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/functions/renderFormViewer.md): renderFormViewer(elementId, props): Root - [Function: renderFormViewerTo()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/functions/renderFormViewerTo.md): renderFormViewerTo(container, props): Root - [rSuiteComponents](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents.md): Interfaces - [Function: formEngineRsuiteCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/formEngineRsuiteCssLoader.md): formEngineRsuiteCssLoader(): Promise\ - [Function: ltrCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/ltrCssLoader.md): ltrCssLoader(): Promise\ - [Function: RsLocalizationWrapper()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/RsLocalizationWrapper.md): RsLocalizationWrapper(props): Element - [Function: rtlCssLoader()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/functions/rtlCssLoader.md): rtlCssLoader(): Promise\ - [Interface: RsAutoCompleteProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsAutoCompleteProps.md): The properties of the RsAutoComplete component. - [Interface: RsBreadcrumbItemProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbItemProps.md): Props for a single breadcrumb item. - [Interface: RsBreadcrumbProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsBreadcrumbProps.md): Props for the RsBreadcrumb component. - [Interface: RsCalendarProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsCalendarProps.md): Props for the RsCalendar component. - [Interface: RsCardProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsCardProps.md): Props for the RsCard component. - [Interface: RsContainerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsContainerProps.md): Props for the RsContainer component. - [Interface: RsDatePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsDatePickerProps.md): Props for the RsDatePicker component. - [Interface: RsDropdownProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsDropdownProps.md): Props for the RsDropdown component. - [Interface: RsErrorMessageProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsErrorMessageProps.md): The properties of RsErrorMessage component. - [Interface: RsHeaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsHeaderProps.md): Props for the RsHeader component. - [Interface: RsImageProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsImageProps.md): Props for the RsImage component. - [Interface: RsInputProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsInputProps.md): Props for the RsInput component. - [Interface: RsLabelProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsLabelProps.md): Props for the RsLabel component. - [Interface: RsLinkProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsLinkProps.md): Props for the RsLink component. - [Interface: RsMenuProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsMenuProps.md): Props for the RsMenu component. - [Interface: RsModalLayoutProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsModalLayoutProps.md): Props for the RsModalLayout component. - [Interface: RsModalProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsModalProps.md): Props for the RsModal component. - [Interface: RsNumberFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsNumberFormatProps.md): Props for the RsNumberFormat component. - [Interface: RsPatternFormatProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsPatternFormatProps.md): Props for the RsPatternFormat component. - [Interface: RsRadioGroupProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsRadioGroupProps.md): Props for the RsRadioGroup component. - [Interface: RsSearchProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsSearchProps.md): Props for the RsSearch component. - [Interface: RsStaticContentProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsStaticContentProps.md): Props for the RsStaticContent component. - [Interface: RsTabProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTabProps.md): Props for the RsTab component. - [Interface: RsTagPickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTagPickerProps.md): Props for the RsTagPicker component. - [Interface: RsTextAreaProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTextAreaProps.md): Props for the RsTextArea component. - [Interface: RsTimePickerProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTimePickerProps.md): Props for the RsTimePicker component. - [Interface: RsTooltipProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsTooltipProps.md): The properties of RsTooltip component. - [Interface: RsUploaderProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsUploaderProps.md): Props for the RsUploader component. - [Interface: RsWizardProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardProps.md): Props for the RsWizard component. - [Interface: RsWizardStepProps](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/interfaces/RsWizardStepProps.md): Props for the RsWizardStep component. - [Type Alias: LoadCallback()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/LoadCallback.md): LoadCallback = (newData) => void - [Type Alias: LoadDataHandler()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/LoadDataHandler.md): LoadDataHandler = (searchKeyword, loadCallback, currentDataLength) => object - [Type Alias: MenuItem](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/MenuItem.md): MenuItem = object - [Type Alias: RsTabItem](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/type-aliases/RsTabItem.md): RsTabItem = object - [Variable: builderViewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/builderViewWithCss.md): const builderViewWithCss: BuilderView - [Variable: models](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/models.md): const models: Model\[] - [Variable: rsAutoComplete](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsAutoComplete.md): const rsAutoComplete: Definer\ - [Variable: rsBreadcrumb](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsBreadcrumb.md): const rsBreadcrumb: Definer\ - [Variable: rsButton](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsButton.md): const rsButton: Definer\ - [Variable: rsCalendar](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsCalendar.md): const rsCalendar: Definer\ - [Variable: rsCard](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsCard.md): const rsCard: Definer\ - [Variable: rsCheckbox](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsCheckbox.md): const rsCheckbox: Definer\\> - [Variable: rsContainer](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsContainer.md): const rsContainer: Definer\\> - [Variable: rsDatePicker](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsDatePicker.md): const rsDatePicker: Definer\ - [Variable: rsDivider](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsDivider.md): const rsDivider: Definer\, WithAsProps\\> & DividerProps\>\>\> - [Variable: rsDropdown](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsDropdown.md): const rsDropdown: Definer\ - [Variable: rsErrorMessage](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsErrorMessage.md): const rsErrorMessage: Definer\ - [Variable: rsHeader](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsHeader.md): const rsHeader: Definer\ - [Variable: rsImage](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsImage.md): const rsImage: Definer\ - [Variable: rsInput](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsInput.md): const rsInput: Definer\ - [Variable: rsLabel](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsLabel.md): const rsLabel: Definer\ - [Variable: rsLink](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsLink.md): const rsLink: Definer\ - [Variable: rsMenu](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsMenu.md): const rsMenu: Definer\ - [Variable: rsMessage](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsMessage.md): const rsMessage: Definer\\> & MessageProps\> & WithAsProps\\> & MessageProps & object & object\> - [Variable: rsModal](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsModal.md): const rsModal: Definer\ - [Variable: rsModalLayout](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsModalLayout.md): const rsModalLayout: Definer\ - [Variable: rsNumberFormat](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsNumberFormat.md): const rsNumberFormat: Definer\ - [Variable: rsPatternFormat](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPatternFormat.md): const rsPatternFormat: Definer\ - [Variable: rsPlaceholderGraph](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGraph.md): const rsPlaceholderGraph: Definer\, WithAsProps\\> & PlaceholderGraphProps\>\>\> - [Variable: rsPlaceholderGrid](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderGrid.md): const rsPlaceholderGrid: Definer\, WithAsProps\\> & PlaceholderGridProps\>\>\> - [Variable: rsPlaceholderParagraph](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsPlaceholderParagraph.md): const rsPlaceholderParagraph: Definer\, WithAsProps\\> & PlaceholderParagraphProps\>\>\> - [Variable: rsProgressCircle](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsProgressCircle.md): const rsProgressCircle: Definer\, WithAsProps\\> & ProgressCircleProps\>\>\> - [Variable: rsProgressLine](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsProgressLine.md): const rsProgressLine: Definer\, WithAsProps\\> & ProgressLineProps\>\>\> - [Variable: rsRadioGroup](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsRadioGroup.md): const rsRadioGroup: Definer\ - [Variable: rsSearch](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsSearch.md): const rsSearch: Definer\ - [Variable: rsStaticContent](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsStaticContent.md): const rsStaticContent: Definer\ - [Variable: rsTab](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTab.md): const rsTab: Definer\ - [Variable: rsTagPicker](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTagPicker.md): const rsTagPicker: Definer\ - [Variable: rsTextArea](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTextArea.md): const rsTextArea: Definer\ - [Variable: rsTimePicker](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTimePicker.md): const rsTimePicker: Definer\ - [Variable: rsToggle](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsToggle.md): const rsToggle: Definer\\> & ToggleProps\> & WithAsProps\\> & ToggleProps & object & object\> - [Variable: rsTooltip](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsTooltip.md): const rsTooltip: Definer\ - [Variable: rSuiteComponents](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponents.md): const rSuiteComponents: Definer\[] = [] - [Variable: rSuiteComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rSuiteComponentsDescriptions.md): const rSuiteComponentsDescriptions: Record\ - [Variable: rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rSuiteEnUsComponentsDescriptions.md): rSuiteEnUsComponentsDescriptions: object - [Variable: rsUploader](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsUploader.md): const rsUploader: Definer\ - [Variable: rsWizard](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsWizard.md): const rsWizard: Definer\ - [Variable: rsWizardStep](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/rsWizardStep.md): const rsWizardStep: Definer\ & HTMLAttributes\\> - [Variable: view](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/view.md): const view: View - [Variable: viewWithCss](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/namespaces/rSuiteComponents/variables/viewWithCss.md): const viewWithCss: View - [Variable: createView()](https://formengine.io/documentation/api-reference/@react-form-builder/viewer-bundle/variables/createView.md): 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/building-forms-via-code.md): How to create a form using code. ### 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/camunda-integration.md): Camunda is a comprehensive workflow automation and decision-making platform that provides process management solutions for organizations of ### category - [FAQ](https://formengine.io/documentation/category/faq.md): Drag'n'Drop Form builder frequently asked questions. - [Guides](https://formengine.io/documentation/category/guides.md): Drag'n'Drop Form builder guides. ### component-styling Overview - [Component styling](https://formengine.io/documentation/component-styling.md): Overview ### components-library Components based on the React Suite package are available in the - [Components library](https://formengine.io/documentation/components-library.md): Components based on the React Suite package are available in the - [Fields components](https://formengine.io/documentation/components-library/fields-components.md) - [AutoComplete](https://formengine.io/documentation/components-library/fields-components/autocomplete.md): The AutoComplete component allows you to add an auto-complete field to a form. - [Calendar](https://formengine.io/documentation/components-library/fields-components/calendar.md): The Calendar component enables you to add a calendar to your form. - [Checkbox](https://formengine.io/documentation/components-library/fields-components/checkbox.md): Allows your users to confirm or agree with your provided statement - [DatePicker](https://formengine.io/documentation/components-library/fields-components/date-picker.md): Highly customizable component that enables users to enter and pick dates and times in different formats - [Dropdown](https://formengine.io/documentation/components-library/fields-components/dropdown.md): Dropdown is a component that is used to create a list of predefined choices and options. - [Google Map](https://formengine.io/documentation/components-library/fields-components/google-map.md): The Google Map component enables you to add an interactive map with customizable markers and controls. - [Input](https://formengine.io/documentation/components-library/fields-components/input.md): The Input component is a text input field that allows users to enter and edit text - [Number format](https://formengine.io/documentation/components-library/fields-components/number-format.md): Powerful input formatter that allows you to restrict and format user input to specific numeric or string patterns - [Pattern format](https://formengine.io/documentation/components-library/fields-components/pattern-format.md): Pattern format is used for formatting and displaying numbers and numeric values according to your specified pattern - [Radio group](https://formengine.io/documentation/components-library/fields-components/radio-group.md): Allows users to select one option from a list of choices. - [Rich text editor](https://formengine.io/documentation/components-library/fields-components/rich-text-editor.md): Powerful text editor. - [Search](https://formengine.io/documentation/components-library/fields-components/search.md): Allows users to search for specific information within your specified dataset - [Signature](https://formengine.io/documentation/components-library/fields-components/signature.md): A field that allows users to create and capture their handwritten signatures digitally. - [Tag picker](https://formengine.io/documentation/components-library/fields-components/tag-picker.md): Allows users to select one or multiple tags from a predefined list. - [Text area](https://formengine.io/documentation/components-library/fields-components/text-area.md): Multi-line input field that allows users to enter and edit text - [TimePicker](https://formengine.io/documentation/components-library/fields-components/time-picker.md): A component that allows users to enter and select time in various formats. - [Toggle](https://formengine.io/documentation/components-library/fields-components/toggle.md): Switch that allows users to select one of two mutually exclusive options - [Uploader](https://formengine.io/documentation/components-library/fields-components/uploader.md): Used to upload data or attach files to the form - [React Suite components](https://formengine.io/documentation/components-library/rsuite-components.md): The list of React Suite components used in the FormEngine library. - [Static components](https://formengine.io/documentation/components-library/static-components.md) - [Button](https://formengine.io/documentation/components-library/static-components/button.md): Clickable element that allows users to perform an action or trigger an event - [Divider](https://formengine.io/documentation/components-library/static-components/divider.md): Divider are used to group content horizontally or vertically - [Error message](https://formengine.io/documentation/components-library/static-components/error-message.md): Used to display an error message to the user, typically in response to form validation error - [Header](https://formengine.io/documentation/components-library/static-components/header.md): Text element that displays a title or heading - [Image](https://formengine.io/documentation/components-library/static-components/image.md): Enables to upload and customize images - [Label](https://formengine.io/documentation/components-library/static-components/label.md): Used to provide descriptive text or captions - [Link](https://formengine.io/documentation/components-library/static-components/link.md): Creates a hyperlink to another webpage, email address, or file - [Menu](https://formengine.io/documentation/components-library/static-components/menu.md): Navigation menu that provides a list of links to different sections - [Message](https://formengine.io/documentation/components-library/static-components/message.md): Displays a message or notification to the user - [Placeholder graph](https://formengine.io/documentation/components-library/static-components/placeholder-graph.md): Shows the graph placeholder before loading the component - [Placeholder grid](https://formengine.io/documentation/components-library/static-components/placeholder-grid.md): Shows the grid placeholder before loading the component - [Placeholder paragraph](https://formengine.io/documentation/components-library/static-components/placeholder-paragraph.md): Shows the paragraph placeholder before loading the component - [Progress Circle](https://formengine.io/documentation/components-library/static-components/progress-circle.md): Represents a circular progress indicator for users - [Progress Line](https://formengine.io/documentation/components-library/static-components/progress-line.md): Provides a linear progress indicator for users - [QR code](https://formengine.io/documentation/components-library/static-components/qr-code.md): Displays QR-code with or without a picture inside it - [Static Content](https://formengine.io/documentation/components-library/static-components/static-content.md): Displays static text content within an HTML span tag - [Tooltip](https://formengine.io/documentation/components-library/static-components/tooltip.md): Text box that appears when users interact with your component - [Structure components](https://formengine.io/documentation/components-library/structure-components.md) - [Breadcrumb](https://formengine.io/documentation/components-library/structure-components/breadcrumb.md): Displays a hierarchical trail of links - [Card](https://formengine.io/documentation/components-library/structure-components/card.md): Creates organized layout for your components - [Container](https://formengine.io/documentation/components-library/structure-components/container.md): Wraps other components, providing a way to group and organize content - [Modal](https://formengine.io/documentation/components-library/structure-components/modal.md): Displays a modal window - [Modal layout](https://formengine.io/documentation/components-library/structure-components/modal-layout.md): Provides an appearance for a modal window - [Repeater](https://formengine.io/documentation/components-library/structure-components/repeater.md): Displays a repeating set of components - [RsModal](https://formengine.io/documentation/components-library/structure-components/rs-modal.md): Displays a React Suite modal window - [Tab](https://formengine.io/documentation/components-library/structure-components/tab.md): Allows users to switch between different views or panels - [Table / Data grid](https://formengine.io/documentation/components-library/structure-components/table.md): A table displays rows of data - [Wizard](https://formengine.io/documentation/components-library/structure-components/wizard.md): Allows users to create multistep forms or wizards. - [Wizard step](https://formengine.io/documentation/components-library/structure-components/wizard-step.md): Allows users to add steps to the Wizard component. - [Templates components](https://formengine.io/documentation/components-library/templates-components.md) - [Slot](https://formengine.io/documentation/components-library/templates-components/slot.md): 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/components-with-multiple-children.md): How to define components with multiple children components. ### 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 - [Computed properties](https://formengine.io/documentation/computed-properties.md): 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 Overview - [Conditional rendering](https://formengine.io/documentation/conditional-rendering.md): Overview ### custom-components Overview - [Custom components](https://formengine.io/documentation/custom-components.md): Overview ### designer-customization Customizing the FormBuilder interface - [Designer customization](https://formengine.io/documentation/designer-customization.md): Customizing the FormBuilder interface ### designer-localization Using custom languages in Designer can greatly enhance your project by allowing you to target a specific audience or customize the user - [Designer localization](https://formengine.io/documentation/designer-localization.md): 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 How to make a form or part of it disabled or read-only - [Disabled and read-only properties](https://formengine.io/documentation/disabled-and-read-only.md): How to make a form or part of it disabled or read-only ### dynamic-dropdown-population How to fill dropdown dynamically. - [Dynamic dropdown population](https://formengine.io/documentation/dynamic-dropdown-population.md): 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/enabling-google-maps-autocomplete.md): Guide to setting up Google Maps with autocomplete functionality. ### external-api-access You can access the desired API via custom actions, which are called on a specific event, such as onClick. - [Access to external API from Form Designer](https://formengine.io/documentation/external-api-access.md): You can access the desired API via custom actions, which are called on a specific event, such as onClick. ### 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/form-data.md): FormEngine provides a flexible, reactive architecture for working with form data, allowing integration with other apps and ### 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 storage](https://formengine.io/documentation/form-storage.md): By default, the designer does not use external form stores. In this mode you can create forms, export and import forms to JSON files. ### formik-integration Introduction to FormEngine - [Formik integration](https://formengine.io/documentation/formik-integration.md): Introduction to FormEngine ### 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. - [Form's JSON](https://formengine.io/documentation/forms-json.md): 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. ### getting-form-json Getting form JSON. - [Getting JSON form in React component](https://formengine.io/documentation/getting-form-json.md): Getting form JSON. ### getting-started Read articles about using FormEngine. - [Getting started](https://formengine.io/documentation/getting-started.md): Read articles about using FormEngine. ### installation Installing the Designer and Viewer packages of FormEngine. - [Installation](https://formengine.io/documentation/installation.md): Installing the Designer and Viewer packages of 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/integration-with-electron.md): How to run FormEngine in Electron and connect the Monaco editor locally, without CDN. ### license-key Contact our sales department to obtain a licence key. - [License key](https://formengine.io/documentation/license-key.md): Contact our sales department to obtain a licence key. ### linking-dropdowns Describes how to link dropdown components. - [Linking dropdown components](https://formengine.io/documentation/linking-dropdowns.md): Describes how to link dropdown components. ### localization Overview - [Localization](https://formengine.io/documentation/localization.md): Overview ### 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 - [Modal components](https://formengine.io/documentation/modal-components.md): 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 Form Builder supports nested components out of the box. There are two types of nested components: - [Nested components](https://formengine.io/documentation/nested-components.md): Form Builder supports nested components out of the box. There are two types of nested components: ### overview Overview of FormEngine's NPM packages. - [Overview](https://formengine.io/documentation/overview.md): Overview of FormEngine's NPM packages. ### presets-components Create a preset component in Designer - [Preset components](https://formengine.io/documentation/presets-components.md): Create a preset component in Designer ### release-notes 7.6.0 - [Release notes](https://formengine.io/documentation/release-notes.md): 7.6.0 ### 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/roadmap.md): 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. ### storing-user-defined-data Each component that implements IFormData can maintain a user-defined data - [Storing user-defined data](https://formengine.io/documentation/storing-user-defined-data.md): Each component that implements IFormData can maintain a user-defined data ### styling-multiple-components Showcases how to style multiple components using CSS. - [Styling multiple components](https://formengine.io/documentation/styling-multiple-components.md): 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/support.md): Do you need help, found a bug or have an idea? ### theme-manipulation How to set a designer theme (light, dark, or system theme). - [Theme manipulation](https://formengine.io/documentation/theme-manipulation.md): How to set a designer theme (light, dark, or system theme). ### 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/tracking-form-changes.md): 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/updating-rsuite.md): To update the RSuite library in Optimajet’s Designer or Components RSuite, you need to gain access to the source code. ### usage Examples of Designer and Viewer usage. - [Usage](https://formengine.io/documentation/usage.md): Examples of Designer and Viewer usage. ### usage-with-nextjs The FormEngine is fully compatible with the latest versions of the Next.js. - [Usage with Next.js](https://formengine.io/documentation/usage-with-nextjs.md): 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/usage-with-remix.md): The FormEngine is fully compatible with the latest versions of the Remix. ### user-defined-properties How to override the properties of a component in runtime. - [User defined properties](https://formengine.io/documentation/user-defined-properties.md): How to override the properties of a component in runtime. ### using-repeater Learn how to use the Repeater component in your project. - [Using Repeater](https://formengine.io/documentation/using-repeater.md): Learn how to use the Repeater component in your project. ### using-tabs Imagine you have a component that displays tabs. As an example, let's use the Nav component from - [Using tabs](https://formengine.io/documentation/using-tabs.md): Imagine you have a component that displays tabs. As an example, let's use the Nav component from ### validation Overview - [Validation](https://formengine.io/documentation/validation.md): Overview ### writing-values-via-actions How to manipulate values using actions and computed properties. - [Writing values via actions and computed properties](https://formengine.io/documentation/writing-values-via-actions.md): 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 * 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 © 2025 Optimajet Limited. All rights reserved. --- # Actions ## Overview[​](#overview "Direct link to Overview") Actions are reusable, asynchronous JavaScript functions that enable you to handle events and interact with your form in a flexible and efficient way. There are three types of actions: * **Common**: These are pre-defined actions that provide a convenient way to perform common tasks with a form, such as: * *validate*: Validates the form. * *clear*: Clears the form fields. * *reset*: Sets the value of form fields to their default value. * **Code**: These actions allow you to write custom JavaScript code directly in the designer's code editor. * **Custom**: These are custom actions that can be passed as properties to the FormBuilder or FormViewer component. ## Events[​](#events "Direct link to Events") Two events are described for each component connected to Form Builder: `onDidMount`, `onWillUnmount`. These events are triggered when a component is mounted and unmounted, as for a typical React component. If you want to use other component events, you must use [event](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionEventArgs.md#event) to define the component property you need. Example: ``` export const myButton = define(MyButton, 'MyButton') .name('MyButton') .props({ children: string.required.named('Content').hinted('Caption').default('My Button'), danger: boolean.hinted('Set the danger status of button'), disabled: boolean.hinted('Disabled state of button'), onClick: event }) ``` In the above code, the `onClick` property is defined as `event`. After connecting the component to the designer, you will see the `onClick` event in the list of available component events and will be able to bind an action to this event. ## Working with actions[​](#working-with-actions "Direct link to Working with actions") ### Description[​](#description "Direct link to Description") Actions work [asynchronously](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Introducing), which means that they are executed in a sequential, step-by-step manner. This approach allows for efficient processing of multiple actions, ensuring that your form remains responsive and interactive. Here's how actions work: 1. When an event is triggered, the assigned actions are executed one by one, in the order they were defined. 2. Each action is executed independently, allowing the next action to start only when the previous one has completed. 3. If an action encounters an error and returns a failure, the entire sequence of actions will be terminated, and no further actions will be executed. The asynchronous approach ensures improved performance, flexibility to define complex workflows, and simplified error handling. To illustrate this concept, let's consider an example: Suppose you have a form that inquires users to enter their data and click *Save*. The Save button incorporates two onClick actions: * First for validating the results * Second for showing the validation results Therefore, in case the first validation action fails due to invalid data, the entire sequence will be terminated, and the following action will not be executed. For more details, follow the example below that illustrates how to define this sequence and such actions. ### Example[​](#example "Direct link to Example") Let's open our [demo](https://demo.formengine.io/) and select the *Save* button in the designer, as shown in the screenshot below. In the right panel, select the "Actions" tab. ![Actions 01](/documentation/assets/images/actions-01-52b8dc79b9074119736f646944774f0f.png) There are two handlers attached to the `onClick` event: `validate` and `showValidationResult`. The `showValidationResult` action is editable because it is a "Code" action. The actions are executed sequentially, one after the other. You can change the order in which the actions are called by simply dragging and dropping their names in the list. And of course you can add and remove actions. Click on the pen icon next to `showValidationResult` to open the action code editor. You should see similar to the screenshot below: ![Actions 02](/documentation/assets/images/actions-02-58199c2282d36e1fa4bf02867bda587c.png) As you can see, an action is simply an asynchronous JavaScript function. The mandatory parameter is the action name and handler code. In the right part you can specify the action parameters. If the action has parameters, you can pass the values of the arguments to the parameters in the binding of the action to the event. Let's take a closer look at the action code. showValidationResult ``` /** * @param {ActionEventArgs} e - the action arguments. * @param {} args - the action parameters arguments. */ async function Action (e, args) { const setVisible = (key, visible) => { const componentStore = e.store.form.componentTree.findByKey(key)?.store if (componentStore) { componentStore.renderWhen = {value: visible} } } const hasErrors = e.store.form.componentTree.hasErrors setVisible('errorMessage', hasErrors) setVisible('successMessage', !hasErrors) } ``` There are two parameters in this function: 1. e is an object of type [ActionEventArgs](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionEventArgs.md). 2. args - this object will store values of arguments of action parameters. Line 6 contains the `setVisible` function, which is responsible for hiding or displaying the component on the form using the `renderWhen` property. The `hasErrors` variable gets the value `true` if the form contains validation errors (line 12). Lines 13 and 14 show/hide components with `key` field "errorMessage" and "successMessage". That is, in fact, this function just shows the component displaying the error or the component displaying the success of validation of the whole form. ## Custom actions[​](#custom-actions "Direct link to Custom actions") Custom actions can be passed through the [actions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps.md#actions) parameter. The passed custom actions will be available in the selection in the form designer. You can find an example [this](https://formengine.io/documentation/documentation/usage.md#designer) page. ``` console.log(e), assertArgs: ActionDefinition.functionalAction((e, args) => { console.log(e, args) }, { p1: 'string', p2: 'boolean', p3: 'number', p4: 'function' }) }} /> ``` In the simplest case, a custom function is just an arrow function like `logEventArgs` from the example above. If you need a function with parameters, use the [ActionDefinition.functionalAction](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/ActionDefinition.md#functionalaction) function to define the action, as in the case of `assertArgs`. ## Common actions[​](#common-actions "Direct link to Common actions") Common actions, also known as *common functions*, are reusable functions that can be used across multiple forms to perform specific tasks. These functions enable the reuse of various events on form inputs, making it easier to manage and maintain complex form logic. These common functions can be used via both *FormBuilder* and *FormViewer*. Common functions are defined via the [actions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/FormViewerProps.md#actions) parameter. The following provides an example that showcases how to define a new common function for **FormBuilder** via this property: ``` { console.log('onFormDataChange', {data, errors}) }} viewerRef={setRef} validators={customValidators} actions={{ weatherRequest: ActionDefinition.functionalAction(async (e, args) => { let latitude = Number(e.data.latitude) if (Number.isNaN(latitude)) latitude = 40.416763 let longitude = Number(e.data.longitude) if (Number.isNaN(longitude)) longitude = -3.703999 try { const request = await fetch(`https://api.open-meteo.com/v1/forecast?latitude=${latitude}&longitude=${longitude}¤t_weather=true&ourly=temperature_2m,elativehumidity_2m,windspeed_10m`, {signal: AbortSignal.timeout(10000)}) const value = await request.json() e.setUserDefinedProps({children: `Current weather is ${value.current_weather.temperature} °C`}) } catch (error) { e.setUserDefinedProps({children: `Current weather is not available`}) } }) }} /> ``` This example function is called `weatherRequest` and it is implemented via the Open Meteo API. As the name implies, this function is used to check the weather and display the results within forms. This function requires to specify coordinates. In case the weather data is available for specified coordinates the function returns the temperature in Celsius. The code snippet below showcases how to define a form that works with this function: ``` { "version": "1", "form": { "key": "Screen", "type": "Screen", "props": {}, "children": [ { "key": "rsContainer1", "type": "RsContainer", "props": {}, "css": { "any": { "object": { "flexDirection": "row" } } }, "children": [ { "key": "latitude", "type": "RsInput", "props": { "label": { "value": "Latitude" }, "placeholder": { "value": "Enter latitude, for example 40.416763" } } }, { "key": "longitude", "type": "RsInput", "props": { "placeholder": { "value": "Enter longitude, for example -3.703999" }, "label": { "value": "Longitude" } } } ] }, { "key": "rsButton1", "type": "RsButton", "props": { "active": { "value": false }, "appearance": { "value": "primary" }, "color": { "value": "blue" }, "children": { "value": "Check weather" } }, "events": { "onClick": [ { "name": "weatherRequest", "type": "custom" } ] } } ] }, "localization": {}, "languages": [ { "code": "en", "dialect": "US", "name": "English", "description": "American English", "bidi": "ltr" } ], "defaultLanguage": "en-US" } ``` The following snippet showcases how to implement the `weatherRequest` function for **FormViewer**: ``` { let latitude = Number(e.data.latitude) if (Number.isNaN(latitude)) latitude = 40.416763 let longitude = Number(e.data.longitude) if (Number.isNaN(longitude)) longitude = -3.703999 try { const request = await fetch(`https://api.open-meteo.com/v1/forecast?latitude=${latitude}&longitude=${longitude}¤t_weather=true&ourly=temperature_2m,elativehumidity_2m,windspeed_10m`, {signal: AbortSignal.timeout(10000)}) const value = await request.json() e.setUserDefinedProps({children: `Current weather is ${value.current_weather.temperature} °C`}) } catch (error) { e.setUserDefinedProps({children: `Current weather is not available`}) } }) }} {...otherProps} /> ``` Therefore, by adding the `weatherRequest` function to FormViewer or FormBuilder and using the provided example form, you can enter the coordinates and display the temperature data. You will also be able to use this function as a common action within your other defined forms. --- # 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 can select the device for which the styles will be applied. The device is determined by the width of the window: 1. **Any** - these styles are applied to all devices, regardless of window width. 2. **Desktop** - for desktop devices with a window width greater than 900 pixels. 3. **Mobile** - for mobile devices where the window width is less than or equal to 600 pixels. 4. **Tablet** - for tablet devices where the window width is less than or equal to 900 pixels. 5. **Custom breakpoints** - this functionality is in development. Will be added later. Let's take a look at how this works. To demonstrate, let's create a form with three fields located in one container. ![Adaptive layout 01](/documentation/assets/images/adaptive-layout-01-cc2d1d1b45ba51a2719c354ebbef5c2b.png) This is a ready-made JSON form with this example. You can copy it to the JSON form editor for see how it works. Click the **\** button, then paste the code below and close the "Edit JSON" window. Form JSON ``` { "version": "1", "form": { "key": "Screen", "type": "Screen", "props": {}, "css": { "any": { "string": "" }, "desktop": { "string": " padding: 20px;\n border: 1px solid lightgrey;\n border-radius: 6px;" } }, "children": [ { "key": "container", "type": "RsContainer", "props": {}, "css": { "any": { "object": { "flexDirection": "row" } }, "mobile": { "object": { "flexDirection": "row", "flexWrap": "wrap" } } }, "children": [ { "key": "name", "type": "RsInput", "props": { "label": { "value": "Name" } }, "wrapperCss": { "mobile": { "object": { "width": "100%" } }, "any": { "object": { "width": "100%" } } } }, { "key": "surname", "type": "RsInput", "props": { "label": { "value": "Surname" } }, "wrapperCss": { "mobile": { "object": { "width": "auto" }, "string": " flex: 1;" }, "any": { "object": { "width": "100%" } } }, "css": { "mobile": { "string": " " } } }, { "key": "sex", "type": "RsDropdown", "props": { "label": { "value": "Sex" } }, "wrapperCss": { "mobile": { "object": { "width": "auto" }, "string": " flex: 1;" } } } ] } ] }, "localization": {}, "languages": [ { "code": "en", "dialect": "US", "name": "English", "description": "American English", "bidi": "ltr" } ], "defaultLanguage": "en-US" } ``` We have added the following styles for the `Screen` in `Desktop` mode: ``` element.style { padding: 20px; border: 1px solid lightgrey; border-radius: 6px; } ``` ![Adaptive layout 02](/documentation/assets/images/adaptive-layout-02-c82bf4d626fba46ba98d232a29473d75.png) This is how it looks in Preview mode: ![Adaptive layout 03](/documentation/assets/images/adaptive-layout-03-d4cb00abfa2c96214bb6b50d5f497860.png) We have also set the `Direction: row` and `Flex wrap: wrap` for the container in `Mobile` mode: ![Adaptive layout 04](/documentation/assets/images/adaptive-layout-04-1706e56e3a4551bd20c2b489838b591f.png) And set `Width: auto` and `flex: 1` for `Surname` and `Sex` inputs `Wrapper`: ![Adaptive layout 05](/documentation/assets/images/adaptive-layout-05-3f92d73c70ffaf4d65640e26de997ce6.png) Now we can look at the result by switching between devices in display modes: ![Adaptive layout 06](/documentation/assets/images/adaptive-layout-06-63942f11d4342cea8af9c90b46889f04.png) --- # 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/components-library/static-components/qr-code.md). ## 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( , ) ``` 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 } 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(null) useEffect(() => { renderQr(ref).catch(console.error) }, []) return
} async function renderQr(ref: RefObject) { 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 } 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): Promise; ``` 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(null) useEffect(() => { renderQr(ref).catch(console.error) }, []) return
} async function renderQr(ref: RefObject) { 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} module_or_path * * @returns {Promise} */ export default function __wbg_init(module_or_path?: InitInput | Promise): Promise; ``` 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(null) useEffect(() => { renderQr(props, ref).catch(console.error) }, [props]) return
} 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) { 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/.md) * [@react-form-builder/components-google-map](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/.md) * [@react-form-builder/components-rich-text](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/.md) * [@react-form-builder/components-rsuite](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/.md) * [@react-form-builder/components-signature](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-signature/.md) * [@react-form-builder/core](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/.md) * [@react-form-builder/designer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer/.md) * [@react-form-builder/designer-bundle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/designer-bundle/.md) * [@react-form-builder/viewer-bundle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle/.md) * [@react-form-builder/viewer-bundle-premium](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/viewer-bundle-premium/.md) --- # @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.md) ## Variables[​](#variables "Direct link to Variables") * [fastQrComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponent.md) * [fastQrComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrComponentsDescriptions.md) * [fastQrEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrEnUsComponentsDescriptions.md) * [fastQrModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/variables/fastQrModel.md) --- # 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.md)<[`FastQrProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-fast-qr/interfaces/FastQrProps.md)> = `fastQr` --- # Variable: fastQrComponentsDescriptions > `const` **fastQrComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode.md), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription.md)> --- # 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.md)<`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.md) ## 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.md) * [MapMarker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/MapMarker.md) ## Variables[​](#variables "Direct link to Variables") * [googleMapComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponent.md) * [googleMapComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapComponentsDescriptions.md) * [googleMapEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapEnUsComponentsDescriptions.md) * [googleMapModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/variables/googleMapModel.md) ## Functions[​](#functions "Direct link to Functions") * [toAddress](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/functions/toAddress.md) --- # Function: toAddress() > **toAddress**(`components`): [`Address`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/type-aliases/Address.md) Converts the address components to an address object. Original source code from . ## 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.md) 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: . Part of: . *** ### 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.md)\[] 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.md) #### 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.md) ##### 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.md) #### 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.md) 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: . Part of: . *** ### 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.md) 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.md)<[`GoogleMapProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-google-map/interfaces/GoogleMapProps.md)> = `googleMap` --- # Variable: googleMapComponentsDescriptions > `const` **googleMapComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode.md), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription.md)> --- # 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.md)<`any`> --- # @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.md) ## Variables[​](#variables "Direct link to Variables") * [richTextComponent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextComponent.md) * [richTextEditorComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorComponentsDescriptions.md) * [richTextEditorEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextEditorEnUsComponentsDescriptions.md) * [richTextModel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/variables/richTextModel.md) --- # 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**: (`"color"` | `"direction"` | `"font"` | `"header"` | `"script"` | `"list"` | `"insert"` | `"size"` | `"clean"` | `"align"` | `"decoration"` | `"block"` | `"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.md)<[`RichTextEditorProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rich-text/interfaces/RichTextEditorProps.md)> = `richTextEditor` --- # Variable: richTextEditorComponentsDescriptions > `const` **richTextEditorComponentsDescriptions**: `Record`<[`LanguageFullCode`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/LanguageFullCode.md), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription.md)> --- # 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.md)<`any`> --- # @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.md) * [RsBreadcrumbItemProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbItemProps.md) * [RsBreadcrumbProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbProps.md) * [RsCalendarProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCalendarProps.md) * [RsCardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCardProps.md) * [RsContainerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsContainerProps.md) * [RsDatePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDatePickerProps.md) * [RsDropdownProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDropdownProps.md) * [RsErrorMessageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps.md) * [RsHeaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsHeaderProps.md) * [RsImageProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsImageProps.md) * [RsInputProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsInputProps.md) * [RsLabelProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLabelProps.md) * [RsLinkProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLinkProps.md) * [RsMenuProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsMenuProps.md) * [RsModalLayoutProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalLayoutProps.md) * [RsModalProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalProps.md) * [RsNumberFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsNumberFormatProps.md) * [RsPatternFormatProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsPatternFormatProps.md) * [RsRadioGroupProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsRadioGroupProps.md) * [RsSearchProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsSearchProps.md) * [RsStaticContentProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsStaticContentProps.md) * [RsTabProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTabProps.md) * [RsTagPickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTagPickerProps.md) * [RsTextAreaProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTextAreaProps.md) * [RsTimePickerProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTimePickerProps.md) * [RsTooltipProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps.md) * [RsUploaderProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsUploaderProps.md) * [RsWizardProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardProps.md) * [RsWizardStepProps](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsWizardStepProps.md) ## 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.md) * [LoadDataHandler](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/LoadDataHandler.md) * [MenuItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/MenuItem.md) * [RsTabItem](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/type-aliases/RsTabItem.md) ## Variables[​](#variables "Direct link to Variables") * [builderViewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/builderViewWithCss.md) * [models](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/models.md) * [rsAutoComplete](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsAutoComplete.md) * [rsBreadcrumb](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsBreadcrumb.md) * [rsButton](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsButton.md) * [rsCalendar](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCalendar.md) * [rsCard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCard.md) * [rsCheckbox](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsCheckbox.md) * [rsContainer](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsContainer.md) * [rsDatePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDatePicker.md) * [rsDivider](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDivider.md) * [rsDropdown](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsDropdown.md) * [rsErrorMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsErrorMessage.md) * [rsHeader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsHeader.md) * [rsImage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsImage.md) * [rsInput](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsInput.md) * [rsLabel](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLabel.md) * [rsLink](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsLink.md) * [rsMenu](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMenu.md) * [rsMessage](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsMessage.md) * [rsModal](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModal.md) * [rsModalLayout](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsModalLayout.md) * [rsNumberFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsNumberFormat.md) * [rsPatternFormat](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPatternFormat.md) * [rsPlaceholderGraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGraph.md) * [rsPlaceholderGrid](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderGrid.md) * [rsPlaceholderParagraph](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsPlaceholderParagraph.md) * [rsProgressCircle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressCircle.md) * [rsProgressLine](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsProgressLine.md) * [rsRadioGroup](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsRadioGroup.md) * [rsSearch](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsSearch.md) * [rsStaticContent](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsStaticContent.md) * [rsTab](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTab.md) * [rsTagPicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTagPicker.md) * [rsTextArea](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTextArea.md) * [rsTimePicker](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTimePicker.md) * [rsToggle](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsToggle.md) * [rsTooltip](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsTooltip.md) * [rSuiteComponents](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponents.md) * [rSuiteComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteComponentsDescriptions.md) * [rSuiteEnUsComponentsDescriptions](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rSuiteEnUsComponentsDescriptions.md) * [rsUploader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsUploader.md) * [rsWizard](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizard.md) * [rsWizardStep](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/rsWizardStep.md) * [view](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/view.md) * [viewWithCss](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/variables/viewWithCss.md) ## Functions[​](#functions "Direct link to Functions") * [formEngineRsuiteCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/formEngineRsuiteCssLoader.md) * [ltrCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/ltrCssLoader.md) * [RsLocalizationWrapper](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/RsLocalizationWrapper.md) * [rtlCssLoader](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/functions/rtlCssLoader.md) --- # 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.md) 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.md)\[] 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`) => `object` 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.md) #### Returns[​](#returns-1 "Direct link to Returns") `object` *** ### 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") #### 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") #### 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") #### 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.md) 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.md) ## 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.md).[`children`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps.md#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.md).[`className`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps.md#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.md).[`error`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/ErrorWrapperProps.md#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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `ReactI18NextChild` | `Iterable`<`ReactI18NextChild`> #### 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**: `Booleanish` | `"inherit"` | `"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**: `"auto"` | `"async"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-75 "Direct link to Inherited from") `ComponentProps.enterKeyHint` *** ### fetchPriority?[​](#fetchpriority "Direct link to fetchPriority?") > `optional` **fetchPriority**: `"auto"` | `"high"` | `"low"` #### Inherited from[​](#inherited-from-76 "Direct link to Inherited from") `ComponentProps.fetchPriority` *** ### height?[​](#height "Direct link to height?") > `optional` **height**: `string` | `number` #### Inherited from[​](#inherited-from-77 "Direct link to Inherited from") `ComponentProps.height` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-78 "Direct link to Inherited from") `ComponentProps.hidden` *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `string` #### Inherited from[​](#inherited-from-79 "Direct link to Inherited from") `ComponentProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-80 "Direct link to Inherited from") `ComponentProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-81 "Direct link to Inherited from") `ComponentProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"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-30 "Direct link to See") #### Inherited from[​](#inherited-from-82 "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-31 "Direct link to See") #### Inherited from[​](#inherited-from-83 "Direct link to Inherited from") `ComponentProps.is` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-84 "Direct link to Inherited from") `ComponentProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-85 "Direct link to Inherited from") `ComponentProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-86 "Direct link to Inherited from") `ComponentProps.itemRef` *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-87 "Direct link to Inherited from") `ComponentProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-88 "Direct link to Inherited from") `ComponentProps.itemType` *** ### key?[​](#key "Direct link to key?") > `optional` **key**: `null` | `Key` #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `ComponentProps.key` *** ### lang?[​](#lang "Direct link to lang?") > `optional` **lang**: `string` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `ComponentProps.lang` *** ### loading?[​](#loading "Direct link to loading?") > `optional` **loading**: `"eager"` | `"lazy"` #### Inherited from[​](#inherited-from-91 "Direct link to Inherited from") `ComponentProps.loading` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-92 "Direct link to Inherited from") `ComponentProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `ComponentProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `ComponentProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `ComponentProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-96 "Direct link to Inherited from") `ComponentProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-97 "Direct link to Inherited from") `ComponentProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-98 "Direct link to Inherited from") `ComponentProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-99 "Direct link to Inherited from") `ComponentProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-100 "Direct link to Inherited from") `ComponentProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-101 "Direct link to Inherited from") `ComponentProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-102 "Direct link to Inherited from") `ComponentProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-103 "Direct link to Inherited from") `ComponentProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-104 "Direct link to Inherited from") `ComponentProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-105 "Direct link to Inherited from") `ComponentProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `ComponentProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `ComponentProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-108 "Direct link to Inherited from") `ComponentProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `ComponentProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `ComponentProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `ComponentProps.onCanPlayThroughCapture` *** ### onChange?[​](#onchange "Direct link to onChange?") > `optional` **onChange**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `ComponentProps.onChange` *** ### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?") > `optional` **onChangeCapture**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `ComponentProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `ComponentProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `ComponentProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `ComponentProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `ComponentProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `ComponentProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `ComponentProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `ComponentProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `ComponentProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `ComponentProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `ComponentProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `ComponentProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `ComponentProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-126 "Direct link to Inherited from") `ComponentProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-127 "Direct link to Inherited from") `ComponentProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `ComponentProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `ComponentProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `ComponentProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `ComponentProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `ComponentProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `ComponentProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `ComponentProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `ComponentProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `ComponentProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `ComponentProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `ComponentProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `ComponentProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `ComponentProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `ComponentProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `ComponentProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `ComponentProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `ComponentProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `ComponentProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `ComponentProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `ComponentProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `ComponentProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `ComponentProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `ComponentProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `ComponentProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `ComponentProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `ComponentProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `ComponentProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `ComponentProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `ComponentProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `ComponentProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `ComponentProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `ComponentProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `ComponentProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `ComponentProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `ComponentProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-163 "Direct link to Inherited from") `ComponentProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-164 "Direct link to Inherited from") `ComponentProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-165 "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-166 "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-167 "Direct link to Inherited from") `ComponentProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `ComponentProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `ComponentProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `ComponentProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `ComponentProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `ComponentProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `ComponentProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `ComponentProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `ComponentProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `ComponentProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `ComponentProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `ComponentProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `ComponentProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-180 "Direct link to Inherited from") `ComponentProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-181 "Direct link to Inherited from") `ComponentProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-182 "Direct link to Inherited from") `ComponentProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `ComponentProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `ComponentProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `ComponentProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `ComponentProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `ComponentProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `ComponentProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `ComponentProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `ComponentProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `ComponentProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `ComponentProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `ComponentProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `ComponentProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `ComponentProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `ComponentProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `ComponentProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `ComponentProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `ComponentProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `ComponentProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `ComponentProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `ComponentProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `ComponentProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `ComponentProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `ComponentProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `ComponentProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `ComponentProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `ComponentProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `ComponentProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `ComponentProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `ComponentProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `ComponentProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `ComponentProps.onPointerUpCapture` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `ComponentProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `ComponentProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `ComponentProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `ComponentProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `ComponentProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `ComponentProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `ComponentProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `ComponentProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `ComponentProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `ComponentProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `ComponentProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-225 "Direct link to Inherited from") `ComponentProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-226 "Direct link to Inherited from") `ComponentProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `ComponentProps.onSeekingCapture` *** ### onSelect?[​](#onselect "Direct link to onSelect?") > `optional` **onSelect**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-228 "Direct link to Inherited from") `ComponentProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-229 "Direct link to Inherited from") `ComponentProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `ComponentProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `ComponentProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `ComponentProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `ComponentProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `ComponentProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-235 "Direct link to Inherited from") `ComponentProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `ComponentProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `ComponentProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `ComponentProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `ComponentProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `ComponentProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `ComponentProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `ComponentProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `ComponentProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `ComponentProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `ComponentProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `ComponentProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `ComponentProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `ComponentProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `ComponentProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `ComponentProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `ComponentProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `ComponentProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `ComponentProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `ComponentProps.onTransitionStartCapture` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `ComponentProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `ComponentProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `ComponentProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `ComponentProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `ComponentProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLImageElement`> #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `ComponentProps.onWheelCapture` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `ComponentProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `ComponentProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-263 "Direct link to Inherited from") `ComponentProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-264 "Direct link to Inherited from") `ComponentProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `ComponentProps.property` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-266 "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-32 "Direct link to See") [React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `ComponentProps.ref` *** ### referrerPolicy?[​](#referrerpolicy "Direct link to referrerPolicy?") > `optional` **referrerPolicy**: `HTMLAttributeReferrerPolicy` #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `ComponentProps.referrerPolicy` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-269 "Direct link to Inherited from") `ComponentProps.rel` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-270 "Direct link to Inherited from") `ComponentProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `ComponentProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `ComponentProps.rev` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `ComponentProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `ComponentProps.security` *** ### sizes?[​](#sizes "Direct link to sizes?") > `optional` **sizes**: `string` #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `ComponentProps.sizes` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `ComponentProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `ComponentProps.spellCheck` *** ### src?[​](#src "Direct link to src?") > `optional` **src**: `string` #### Inherited from[​](#inherited-from-278 "Direct link to Inherited from") `ComponentProps.src` *** ### srcSet?[​](#srcset "Direct link to srcSet?") > `optional` **srcSet**: `string` #### Inherited from[​](#inherited-from-279 "Direct link to Inherited from") `ComponentProps.srcSet` *** ### 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` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-284 "Direct link to Inherited from") `ComponentProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-285 "Direct link to Inherited from") `ComponentProps.translate` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-286 "Direct link to Inherited from") `ComponentProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-287 "Direct link to Inherited from") `ComponentProps.unselectable` *** ### useMap?[​](#usemap "Direct link to useMap?") > `optional` **useMap**: `string` #### Inherited from[​](#inherited-from-288 "Direct link to Inherited from") `ComponentProps.useMap` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-289 "Direct link to Inherited from") `ComponentProps.vocab` *** ### width?[​](#width "Direct link to width?") > `optional` **width**: `string` | `number` #### Inherited from[​](#inherited-from-290 "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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-79 "Direct link to Inherited from") `InputProps.enterKeyHint` *** ### form?[​](#form "Direct link to form?") > `optional` **form**: `string` #### Inherited from[​](#inherited-from-80 "Direct link to Inherited from") `InputProps.form` *** ### formAction?[​](#formaction "Direct link to formAction?") > `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`> #### Inherited from[​](#inherited-from-81 "Direct link to Inherited from") `InputProps.formAction` *** ### formEncType?[​](#formenctype "Direct link to formEncType?") > `optional` **formEncType**: `string` #### Inherited from[​](#inherited-from-82 "Direct link to Inherited from") `InputProps.formEncType` *** ### formMethod?[​](#formmethod "Direct link to formMethod?") > `optional` **formMethod**: `string` #### Inherited from[​](#inherited-from-83 "Direct link to Inherited from") `InputProps.formMethod` *** ### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?") > `optional` **formNoValidate**: `boolean` #### Inherited from[​](#inherited-from-84 "Direct link to Inherited from") `InputProps.formNoValidate` *** ### formTarget?[​](#formtarget "Direct link to formTarget?") > `optional` **formTarget**: `string` #### Inherited from[​](#inherited-from-85 "Direct link to Inherited from") `InputProps.formTarget` *** ### height?[​](#height "Direct link to height?") > `optional` **height**: `string` | `number` #### Inherited from[​](#inherited-from-86 "Direct link to Inherited from") `InputProps.height` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-87 "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-88 "Direct link to Inherited from") `InputProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `InputProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `InputProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"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-30 "Direct link to See") #### Inherited from[​](#inherited-from-91 "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-92 "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-31 "Direct link to See") #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `InputProps.is` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `InputProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `InputProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-96 "Direct link to Inherited from") `InputProps.itemRef` *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-97 "Direct link to Inherited from") `InputProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-98 "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-99 "Direct link to Inherited from") `InputProps.lang` *** ### list?[​](#list "Direct link to list?") > `optional` **list**: `string` #### Inherited from[​](#inherited-from-100 "Direct link to Inherited from") `InputProps.list` *** ### max?[​](#max "Direct link to max?") > `optional` **max**: `string` | `number` #### Inherited from[​](#inherited-from-101 "Direct link to Inherited from") `InputProps.max` *** ### maxLength?[​](#maxlength "Direct link to maxLength?") > `optional` **maxLength**: `number` #### Inherited from[​](#inherited-from-102 "Direct link to Inherited from") `InputProps.maxLength` *** ### min?[​](#min "Direct link to min?") > `optional` **min**: `string` | `number` #### Inherited from[​](#inherited-from-103 "Direct link to Inherited from") `InputProps.min` *** ### minLength?[​](#minlength "Direct link to minLength?") > `optional` **minLength**: `number` #### Inherited from[​](#inherited-from-104 "Direct link to Inherited from") `InputProps.minLength` *** ### multiple?[​](#multiple "Direct link to multiple?") > `optional` **multiple**: `boolean` #### Inherited from[​](#inherited-from-105 "Direct link to Inherited from") `InputProps.multiple` *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `InputProps.name` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `InputProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-108 "Direct link to Inherited from") `InputProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `InputProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `InputProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `InputProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `InputProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `InputProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `InputProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `InputProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `InputProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `InputProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `InputProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `InputProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `InputProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `InputProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `InputProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `InputProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `InputProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `InputProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-126 "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-127 "Direct link to Inherited from") `InputProps.onChange` *** ### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?") > `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `InputProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `InputProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `InputProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `InputProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `InputProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `InputProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `InputProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `InputProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `InputProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `InputProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `InputProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `InputProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `InputProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `InputProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `InputProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `InputProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `InputProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `InputProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `InputProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `InputProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `InputProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `InputProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `InputProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `InputProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `InputProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `InputProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `InputProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `InputProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `InputProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `InputProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `InputProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `InputProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `InputProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `InputProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `InputProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-163 "Direct link to Inherited from") `InputProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-164 "Direct link to Inherited from") `InputProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-165 "Direct link to Inherited from") `InputProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-166 "Direct link to Inherited from") `InputProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-167 "Direct link to Inherited from") `InputProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `InputProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `InputProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `InputProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `InputProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `InputProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `InputProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `InputProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `InputProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `InputProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `InputProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `InputProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `InputProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-180 "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-181 "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-182 "Direct link to Inherited from") `InputProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `InputProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `InputProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `InputProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `InputProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `InputProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `InputProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `InputProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `InputProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `InputProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `InputProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `InputProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `InputProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `InputProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `InputProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `InputProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `InputProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `InputProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `InputProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `InputProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `InputProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `InputProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `InputProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `InputProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `InputProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `InputProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `InputProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `InputProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `InputProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `InputProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `InputProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `InputProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `InputProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `InputProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `InputProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `InputProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `InputProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `InputProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `InputProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `InputProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `InputProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `InputProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `InputProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-225 "Direct link to Inherited from") `InputProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-226 "Direct link to Inherited from") `InputProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `InputProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-228 "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-229 "Direct link to Inherited from") `InputProps.onPressEnter` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `InputProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `InputProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `InputProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `InputProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `InputProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-235 "Direct link to Inherited from") `InputProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `InputProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `InputProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `InputProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `InputProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `InputProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `InputProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `InputProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `InputProps.onSeekingCapture` *** ### onSelect?[​](#onselect "Direct link to onSelect?") > `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `InputProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `InputProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `InputProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `InputProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `InputProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `InputProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `InputProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `InputProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `InputProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `InputProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `InputProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `InputProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `InputProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `InputProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `InputProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `InputProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `InputProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `InputProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `InputProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-263 "Direct link to Inherited from") `InputProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-264 "Direct link to Inherited from") `InputProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `InputProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `InputProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `InputProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `InputProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-269 "Direct link to Inherited from") `InputProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-270 "Direct link to Inherited from") `InputProps.onTransitionStartCapture` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `InputProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `InputProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `InputProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `InputProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `InputProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `InputProps.onWheelCapture` *** ### 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-277 "Direct link to Inherited from") `InputProps.pattern` *** ### placeholder?[​](#placeholder "Direct link to placeholder?") > `optional` **placeholder**: `string` #### Inherited from[​](#inherited-from-278 "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-279 "Direct link to Inherited from") `InputProps.plaintext` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `InputProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `InputProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-282 "Direct link to Inherited from") `InputProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-283 "Direct link to Inherited from") `InputProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-284 "Direct link to Inherited from") `InputProps.property` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-285 "Direct link to Inherited from") `InputProps.radioGroup` *** ### readOnly?[​](#readonly "Direct link to readOnly?") > `optional` **readOnly**: `boolean` #### Inherited from[​](#inherited-from-286 "Direct link to Inherited from") `InputProps.readOnly` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-287 "Direct link to Inherited from") `InputProps.rel` *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` #### Inherited from[​](#inherited-from-288 "Direct link to Inherited from") `InputProps.required` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-289 "Direct link to Inherited from") `InputProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-290 "Direct link to Inherited from") `InputProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-291 "Direct link to Inherited from") `InputProps.rev` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-292 "Direct link to Inherited from") `InputProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-293 "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-294 "Direct link to Inherited from") `InputProps.size` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-295 "Direct link to Inherited from") `InputProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-296 "Direct link to Inherited from") `InputProps.spellCheck` *** ### src?[​](#src "Direct link to src?") > `optional` **src**: `string` #### Inherited from[​](#inherited-from-297 "Direct link to Inherited from") `InputProps.src` *** ### step?[​](#step "Direct link to step?") > `optional` **step**: `string` | `number` #### Inherited from[​](#inherited-from-298 "Direct link to Inherited from") `InputProps.step` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` Additional style #### Inherited from[​](#inherited-from-299 "Direct link to Inherited from") `InputProps.style` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-300 "Direct link to Inherited from") `InputProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-301 "Direct link to Inherited from") `InputProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-302 "Direct link to Inherited from") `InputProps.tabIndex` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-303 "Direct link to Inherited from") `InputProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-304 "Direct link to Inherited from") `InputProps.translate` *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `"number"` | `"time"` | `"search"` | `"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-305 "Direct link to Inherited from") `InputProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-306 "Direct link to Inherited from") `InputProps.unselectable` *** ### value?[​](#value "Direct link to value?") > `optional` **value**: `string` | `number` | readonly `string`\[] #### Inherited from[​](#inherited-from-307 "Direct link to Inherited from") `InputProps.value` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-308 "Direct link to Inherited from") `InputProps.vocab` *** ### width?[​](#width "Direct link to width?") > `optional` **width**: `string` | `number` #### Inherited from[​](#inherited-from-309 "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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `ReactI18NextChild` | `Iterable`<`ReactI18NextChild`> #### 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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-73 "Direct link to Inherited from") `ComponentProps.enterKeyHint` *** ### fontSize?[​](#fontsize "Direct link to fontSize?") > `optional` **fontSize**: `number` The font size. #### Inherited from[​](#inherited-from-74 "Direct link to Inherited from") `TextProps.fontSize` *** ### fontWeight?[​](#fontweight "Direct link to fontWeight?") > `optional` **fontWeight**: `string` The font weight. #### Inherited from[​](#inherited-from-75 "Direct link to Inherited from") `TextProps.fontWeight` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-76 "Direct link to Inherited from") `ComponentProps.hidden` *** ### href?[​](#href "Direct link to href?") > `optional` **href**: `string` #### Inherited from[​](#inherited-from-77 "Direct link to Inherited from") `ComponentProps.href` *** ### hrefLang?[​](#hreflang "Direct link to hrefLang?") > `optional` **hrefLang**: `string` #### Inherited from[​](#inherited-from-78 "Direct link to Inherited from") `ComponentProps.hrefLang` *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `string` #### Inherited from[​](#inherited-from-79 "Direct link to Inherited from") `ComponentProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-80 "Direct link to Inherited from") `ComponentProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-81 "Direct link to Inherited from") `ComponentProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"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-30 "Direct link to See") #### Inherited from[​](#inherited-from-82 "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-31 "Direct link to See") #### Inherited from[​](#inherited-from-83 "Direct link to Inherited from") `ComponentProps.is` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-84 "Direct link to Inherited from") `ComponentProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-85 "Direct link to Inherited from") `ComponentProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-86 "Direct link to Inherited from") `ComponentProps.itemRef` *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-87 "Direct link to Inherited from") `ComponentProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-88 "Direct link to Inherited from") `ComponentProps.itemType` *** ### key?[​](#key "Direct link to key?") > `optional` **key**: `null` | `Key` #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `ComponentProps.key` *** ### lang?[​](#lang "Direct link to lang?") > `optional` **lang**: `string` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `ComponentProps.lang` *** ### media?[​](#media "Direct link to media?") > `optional` **media**: `string` #### Inherited from[​](#inherited-from-91 "Direct link to Inherited from") `ComponentProps.media` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-92 "Direct link to Inherited from") `ComponentProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `ComponentProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `ComponentProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `ComponentProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-96 "Direct link to Inherited from") `ComponentProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-97 "Direct link to Inherited from") `ComponentProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-98 "Direct link to Inherited from") `ComponentProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-99 "Direct link to Inherited from") `ComponentProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-100 "Direct link to Inherited from") `ComponentProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-101 "Direct link to Inherited from") `ComponentProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-102 "Direct link to Inherited from") `ComponentProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-103 "Direct link to Inherited from") `ComponentProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-104 "Direct link to Inherited from") `ComponentProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-105 "Direct link to Inherited from") `ComponentProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `ComponentProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `ComponentProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-108 "Direct link to Inherited from") `ComponentProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `ComponentProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `ComponentProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `ComponentProps.onCanPlayThroughCapture` *** ### onChange?[​](#onchange "Direct link to onChange?") > `optional` **onChange**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `ComponentProps.onChange` *** ### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?") > `optional` **onChangeCapture**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `ComponentProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `ComponentProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `ComponentProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `ComponentProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `ComponentProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `ComponentProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `ComponentProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `ComponentProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `ComponentProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `ComponentProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `ComponentProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `ComponentProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `ComponentProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-126 "Direct link to Inherited from") `ComponentProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-127 "Direct link to Inherited from") `ComponentProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `ComponentProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `ComponentProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `ComponentProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `ComponentProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `ComponentProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `ComponentProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `ComponentProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `ComponentProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `ComponentProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `ComponentProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `ComponentProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `ComponentProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `ComponentProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `ComponentProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `ComponentProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `ComponentProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `ComponentProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `ComponentProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `ComponentProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `ComponentProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `ComponentProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `ComponentProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `ComponentProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `ComponentProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `ComponentProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `ComponentProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `ComponentProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `ComponentProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `ComponentProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `ComponentProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `ComponentProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `ComponentProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `ComponentProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `ComponentProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `ComponentProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-163 "Direct link to Inherited from") `ComponentProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-164 "Direct link to Inherited from") `ComponentProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-165 "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-166 "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-167 "Direct link to Inherited from") `ComponentProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `ComponentProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `ComponentProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `ComponentProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `ComponentProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `ComponentProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `ComponentProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `ComponentProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `ComponentProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `ComponentProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `ComponentProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `ComponentProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `ComponentProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-180 "Direct link to Inherited from") `ComponentProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-181 "Direct link to Inherited from") `ComponentProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-182 "Direct link to Inherited from") `ComponentProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `ComponentProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `ComponentProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `ComponentProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `ComponentProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `ComponentProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `ComponentProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `ComponentProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `ComponentProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `ComponentProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `ComponentProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `ComponentProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `ComponentProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `ComponentProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `ComponentProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `ComponentProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `ComponentProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `ComponentProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `ComponentProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `ComponentProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `ComponentProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `ComponentProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `ComponentProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `ComponentProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `ComponentProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `ComponentProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `ComponentProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `ComponentProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `ComponentProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `ComponentProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `ComponentProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `ComponentProps.onPointerUpCapture` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `ComponentProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `ComponentProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `ComponentProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `ComponentProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `ComponentProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `ComponentProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `ComponentProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `ComponentProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `ComponentProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `ComponentProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `ComponentProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-225 "Direct link to Inherited from") `ComponentProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-226 "Direct link to Inherited from") `ComponentProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `ComponentProps.onSeekingCapture` *** ### onSelect?[​](#onselect "Direct link to onSelect?") > `optional` **onSelect**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-228 "Direct link to Inherited from") `ComponentProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-229 "Direct link to Inherited from") `ComponentProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `ComponentProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `ComponentProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `ComponentProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `ComponentProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `ComponentProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-235 "Direct link to Inherited from") `ComponentProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `ComponentProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `ComponentProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `ComponentProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `ComponentProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `ComponentProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `ComponentProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `ComponentProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `ComponentProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `ComponentProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `ComponentProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `ComponentProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `ComponentProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `ComponentProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `ComponentProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `ComponentProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `ComponentProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `ComponentProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `ComponentProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `ComponentProps.onTransitionStartCapture` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `ComponentProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `ComponentProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `ComponentProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `ComponentProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `ComponentProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLAnchorElement`> #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `ComponentProps.onWheelCapture` *** ### ping?[​](#ping "Direct link to ping?") > `optional` **ping**: `string` #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `ComponentProps.ping` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `ComponentProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-263 "Direct link to Inherited from") `ComponentProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-264 "Direct link to Inherited from") `ComponentProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `ComponentProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `ComponentProps.property` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-267 "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-32 "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") `ComponentProps.ref` *** ### referrerPolicy?[​](#referrerpolicy "Direct link to referrerPolicy?") > `optional` **referrerPolicy**: `HTMLAttributeReferrerPolicy` #### Inherited from[​](#inherited-from-269 "Direct link to Inherited from") `ComponentProps.referrerPolicy` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-270 "Direct link to Inherited from") `ComponentProps.rel` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `ComponentProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `ComponentProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `ComponentProps.rev` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `ComponentProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `ComponentProps.security` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `ComponentProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `ComponentProps.spellCheck` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` #### Inherited from[​](#inherited-from-278 "Direct link to Inherited from") `ComponentProps.style` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-279 "Direct link to Inherited from") `ComponentProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `ComponentProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `ComponentProps.tabIndex` *** ### target?[​](#target "Direct link to target?") > `optional` **target**: `HTMLAttributeAnchorTarget` #### Inherited from[​](#inherited-from-282 "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-283 "Direct link to Inherited from") `ComponentProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-284 "Direct link to Inherited from") `ComponentProps.translate` *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` #### Inherited from[​](#inherited-from-285 "Direct link to Inherited from") `ComponentProps.type` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-286 "Direct link to Inherited from") `ComponentProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-287 "Direct link to Inherited from") `ComponentProps.unselectable` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-288 "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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-76 "Direct link to Inherited from") `NavProps.enterKeyHint` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-77 "Direct link to Inherited from") `NavProps.hidden` *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `string` #### Inherited from[​](#inherited-from-78 "Direct link to Inherited from") `NavProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-79 "Direct link to Inherited from") `NavProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-80 "Direct link to Inherited from") `NavProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"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-30 "Direct link to See") #### Inherited from[​](#inherited-from-81 "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-31 "Direct link to See") #### Inherited from[​](#inherited-from-82 "Direct link to Inherited from") `NavProps.is` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-83 "Direct link to Inherited from") `NavProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-84 "Direct link to Inherited from") `NavProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-85 "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.md)\[] 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-86 "Direct link to Inherited from") `NavProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-87 "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-88 "Direct link to Inherited from") `NavProps.justified` *** ### lang?[​](#lang "Direct link to lang?") > `optional` **lang**: `string` #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `NavProps.lang` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `NavProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-91 "Direct link to Inherited from") `NavProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-92 "Direct link to Inherited from") `NavProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `NavProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `NavProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `NavProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-96 "Direct link to Inherited from") `NavProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-97 "Direct link to Inherited from") `NavProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-98 "Direct link to Inherited from") `NavProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-99 "Direct link to Inherited from") `NavProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-100 "Direct link to Inherited from") `NavProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-101 "Direct link to Inherited from") `NavProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-102 "Direct link to Inherited from") `NavProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-103 "Direct link to Inherited from") `NavProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-104 "Direct link to Inherited from") `NavProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-105 "Direct link to Inherited from") `NavProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `NavProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `NavProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-108 "Direct link to Inherited from") `NavProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `NavProps.onCanPlayThroughCapture` *** ### onChange?[​](#onchange "Direct link to onChange?") > `optional` **onChange**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `NavProps.onChange` *** ### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?") > `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `NavProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `NavProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `NavProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `NavProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `NavProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `NavProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `NavProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `NavProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `NavProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `NavProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `NavProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `NavProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `NavProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `NavProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `NavProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-126 "Direct link to Inherited from") `NavProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-127 "Direct link to Inherited from") `NavProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `NavProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `NavProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `NavProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `NavProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `NavProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `NavProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `NavProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `NavProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `NavProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `NavProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `NavProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `NavProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `NavProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `NavProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `NavProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `NavProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `NavProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `NavProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `NavProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `NavProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `NavProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `NavProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `NavProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `NavProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `NavProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `NavProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `NavProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `NavProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `NavProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `NavProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `NavProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `NavProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `NavProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `NavProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `NavProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-163 "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-164 "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-165 "Direct link to Inherited from") `NavProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-166 "Direct link to Inherited from") `NavProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-167 "Direct link to Inherited from") `NavProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `NavProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `NavProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `NavProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `NavProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `NavProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `NavProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `NavProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `NavProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `NavProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `NavProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `NavProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `NavProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-180 "Direct link to Inherited from") `NavProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-181 "Direct link to Inherited from") `NavProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-182 "Direct link to Inherited from") `NavProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `NavProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `NavProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `NavProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `NavProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `NavProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `NavProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `NavProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `NavProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `NavProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `NavProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `NavProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `NavProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `NavProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `NavProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `NavProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `NavProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `NavProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `NavProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `NavProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `NavProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `NavProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `NavProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `NavProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `NavProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `NavProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `NavProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `NavProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `NavProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `NavProps.onPointerUpCapture` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `NavProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `NavProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `NavProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `NavProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `NavProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `NavProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `NavProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `NavProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `NavProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `NavProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `NavProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `NavProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `NavProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-225 "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-226 "Direct link to Inherited from") `NavProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `NavProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-228 "Direct link to Inherited from") `NavProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-229 "Direct link to Inherited from") `NavProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `NavProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `NavProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `NavProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `NavProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `NavProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-235 "Direct link to Inherited from") `NavProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `NavProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `NavProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `NavProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `NavProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `NavProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `NavProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `NavProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `NavProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `NavProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `NavProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `NavProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `NavProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `NavProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `NavProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `NavProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `NavProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `NavProps.onTransitionStartCapture` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `NavProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `NavProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `NavProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `NavProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `NavProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `NavProps.onWheelCapture` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `NavProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `NavProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `NavProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `NavProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-263 "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-264 "Direct link to Inherited from") `NavProps.pullRight` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `NavProps.radioGroup` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `NavProps.rel` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `NavProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `NavProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-269 "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-270 "Direct link to Inherited from") `NavProps.reversed` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `NavProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `NavProps.security` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `NavProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `NavProps.spellCheck` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` Additional style #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `NavProps.style` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `NavProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `NavProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-278 "Direct link to Inherited from") `NavProps.tabIndex` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-279 "Direct link to Inherited from") `NavProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `NavProps.translate` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `NavProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-282 "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-283 "Direct link to Inherited from") `NavProps.vertical` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-284 "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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-86 "Direct link to Inherited from") `NumericFormatProps.enterKeyHint` *** ### fixedDecimalScale?[​](#fixeddecimalscale "Direct link to fixedDecimalScale?") > `optional` **fixedDecimalScale**: `boolean` #### Inherited from[​](#inherited-from-87 "Direct link to Inherited from") `NumericFormatProps.fixedDecimalScale` *** ### form?[​](#form "Direct link to form?") > `optional` **form**: `string` #### Inherited from[​](#inherited-from-88 "Direct link to Inherited from") `NumericFormatProps.form` *** ### formAction?[​](#formaction "Direct link to formAction?") > `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`> #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `NumericFormatProps.formAction` *** ### formEncType?[​](#formenctype "Direct link to formEncType?") > `optional` **formEncType**: `string` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `NumericFormatProps.formEncType` *** ### formMethod?[​](#formmethod "Direct link to formMethod?") > `optional` **formMethod**: `string` #### Inherited from[​](#inherited-from-91 "Direct link to Inherited from") `NumericFormatProps.formMethod` *** ### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?") > `optional` **formNoValidate**: `boolean` #### Inherited from[​](#inherited-from-92 "Direct link to Inherited from") `NumericFormatProps.formNoValidate` *** ### formTarget?[​](#formtarget "Direct link to formTarget?") > `optional` **formTarget**: `string` #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `NumericFormatProps.formTarget` *** ### getInputRef?[​](#getinputref "Direct link to getInputRef?") > `optional` **getInputRef**: `Ref`<`any`> | (`el`) => `void` #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `NumericFormatProps.getInputRef` *** ### height?[​](#height "Direct link to height?") > `optional` **height**: `string` | `number` #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `NumericFormatProps.height` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-96 "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-97 "Direct link to Inherited from") `NumericFormatProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-98 "Direct link to Inherited from") `NumericFormatProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-99 "Direct link to Inherited from") `NumericFormatProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"` #### Inherited from[​](#inherited-from-100 "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-101 "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-30 "Direct link to See") #### Inherited from[​](#inherited-from-102 "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-103 "Direct link to Inherited from") `NumericFormatProps.isAllowed` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-104 "Direct link to Inherited from") `NumericFormatProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-105 "Direct link to Inherited from") `NumericFormatProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `NumericFormatProps.itemRef` *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `NumericFormatProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-108 "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-109 "Direct link to Inherited from") `NumericFormatProps.lang` *** ### list?[​](#list "Direct link to list?") > `optional` **list**: `string` #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `NumericFormatProps.list` *** ### max?[​](#max "Direct link to max?") > `optional` **max**: `string` | `number` #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `NumericFormatProps.max` *** ### maxLength?[​](#maxlength "Direct link to maxLength?") > `optional` **maxLength**: `number` #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `NumericFormatProps.maxLength` *** ### min?[​](#min "Direct link to min?") > `optional` **min**: `string` | `number` #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `NumericFormatProps.min` *** ### minLength?[​](#minlength "Direct link to minLength?") > `optional` **minLength**: `number` #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `NumericFormatProps.minLength` *** ### multiple?[​](#multiple "Direct link to multiple?") > `optional` **multiple**: `boolean` #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `NumericFormatProps.multiple` *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `NumericFormatProps.name` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `NumericFormatProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `NumericFormatProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `NumericFormatProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `NumericFormatProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `NumericFormatProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `NumericFormatProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `NumericFormatProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `NumericFormatProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `NumericFormatProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-126 "Direct link to Inherited from") `NumericFormatProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-127 "Direct link to Inherited from") `NumericFormatProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `NumericFormatProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `NumericFormatProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `NumericFormatProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `NumericFormatProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `NumericFormatProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `NumericFormatProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `NumericFormatProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `NumericFormatProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-136 "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-137 "Direct link to Inherited from") `NumericFormatProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `NumericFormatProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `NumericFormatProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `NumericFormatProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `NumericFormatProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `NumericFormatProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `NumericFormatProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `NumericFormatProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `NumericFormatProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `NumericFormatProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `NumericFormatProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `NumericFormatProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `NumericFormatProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `NumericFormatProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `NumericFormatProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `NumericFormatProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `NumericFormatProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `NumericFormatProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `NumericFormatProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `NumericFormatProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `NumericFormatProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `NumericFormatProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `NumericFormatProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `NumericFormatProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `NumericFormatProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `NumericFormatProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-163 "Direct link to Inherited from") `NumericFormatProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-164 "Direct link to Inherited from") `NumericFormatProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-165 "Direct link to Inherited from") `NumericFormatProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-166 "Direct link to Inherited from") `NumericFormatProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-167 "Direct link to Inherited from") `NumericFormatProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `NumericFormatProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `NumericFormatProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `NumericFormatProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `NumericFormatProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `NumericFormatProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `NumericFormatProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `NumericFormatProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `NumericFormatProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `NumericFormatProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `NumericFormatProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `NumericFormatProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `NumericFormatProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-180 "Direct link to Inherited from") `NumericFormatProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-181 "Direct link to Inherited from") `NumericFormatProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-182 "Direct link to Inherited from") `NumericFormatProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `NumericFormatProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `NumericFormatProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `NumericFormatProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `NumericFormatProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `NumericFormatProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `NumericFormatProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-189 "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-190 "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-191 "Direct link to Inherited from") `NumericFormatProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `NumericFormatProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `NumericFormatProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `NumericFormatProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `NumericFormatProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `NumericFormatProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `NumericFormatProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `NumericFormatProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `NumericFormatProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `NumericFormatProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `NumericFormatProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `NumericFormatProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `NumericFormatProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `NumericFormatProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `NumericFormatProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `NumericFormatProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `NumericFormatProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `NumericFormatProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `NumericFormatProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `NumericFormatProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `NumericFormatProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `NumericFormatProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `NumericFormatProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `NumericFormatProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `NumericFormatProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `NumericFormatProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `NumericFormatProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `NumericFormatProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `NumericFormatProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `NumericFormatProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `NumericFormatProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `NumericFormatProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `NumericFormatProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `NumericFormatProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-225 "Direct link to Inherited from") `NumericFormatProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-226 "Direct link to Inherited from") `NumericFormatProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `NumericFormatProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-228 "Direct link to Inherited from") `NumericFormatProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-229 "Direct link to Inherited from") `NumericFormatProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `NumericFormatProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `NumericFormatProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `NumericFormatProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `NumericFormatProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `NumericFormatProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-235 "Direct link to Inherited from") `NumericFormatProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `NumericFormatProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-237 "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-238 "Direct link to Inherited from") `NumericFormatProps.onPressEnter` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `NumericFormatProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `NumericFormatProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `NumericFormatProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `NumericFormatProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `NumericFormatProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `NumericFormatProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `NumericFormatProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `NumericFormatProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `NumericFormatProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `NumericFormatProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `NumericFormatProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `NumericFormatProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `NumericFormatProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `NumericFormatProps.onSeekingCapture` *** ### onSelect?[​](#onselect "Direct link to onSelect?") > `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `NumericFormatProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `NumericFormatProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `NumericFormatProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `NumericFormatProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `NumericFormatProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `NumericFormatProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `NumericFormatProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `NumericFormatProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `NumericFormatProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `NumericFormatProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-263 "Direct link to Inherited from") `NumericFormatProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-264 "Direct link to Inherited from") `NumericFormatProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `NumericFormatProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `NumericFormatProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `NumericFormatProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `NumericFormatProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-269 "Direct link to Inherited from") `NumericFormatProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-270 "Direct link to Inherited from") `NumericFormatProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `NumericFormatProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `NumericFormatProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `NumericFormatProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `NumericFormatProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `NumericFormatProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `NumericFormatProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `NumericFormatProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-278 "Direct link to Inherited from") `NumericFormatProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-279 "Direct link to Inherited from") `NumericFormatProps.onTransitionStartCapture` *** ### onValueChange?[​](#onvaluechange "Direct link to onValueChange?") > `optional` **onValueChange**: `OnValueChange` #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `NumericFormatProps.onValueChange` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `NumericFormatProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-282 "Direct link to Inherited from") `NumericFormatProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-283 "Direct link to Inherited from") `NumericFormatProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-284 "Direct link to Inherited from") `NumericFormatProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-285 "Direct link to Inherited from") `NumericFormatProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-286 "Direct link to Inherited from") `NumericFormatProps.onWheelCapture` *** ### pattern?[​](#pattern "Direct link to pattern?") > `optional` **pattern**: `string` #### Inherited from[​](#inherited-from-287 "Direct link to Inherited from") `NumericFormatProps.pattern` *** ### placeholder?[​](#placeholder "Direct link to placeholder?") > `optional` **placeholder**: `string` #### Inherited from[​](#inherited-from-288 "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-289 "Direct link to Inherited from") `NumericFormatProps.plaintext` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-290 "Direct link to Inherited from") `NumericFormatProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-291 "Direct link to Inherited from") `NumericFormatProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-292 "Direct link to Inherited from") `NumericFormatProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-293 "Direct link to Inherited from") `NumericFormatProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-294 "Direct link to Inherited from") `NumericFormatProps.property` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-295 "Direct link to Inherited from") `NumericFormatProps.radioGroup` *** ### readOnly?[​](#readonly "Direct link to readOnly?") > `optional` **readOnly**: `boolean` #### Inherited from[​](#inherited-from-296 "Direct link to Inherited from") `NumericFormatProps.readOnly` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-297 "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-298 "Direct link to Inherited from") `NumericFormatProps.renderText` *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` #### Inherited from[​](#inherited-from-299 "Direct link to Inherited from") `NumericFormatProps.required` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-300 "Direct link to Inherited from") `NumericFormatProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-301 "Direct link to Inherited from") `NumericFormatProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-302 "Direct link to Inherited from") `NumericFormatProps.rev` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-303 "Direct link to Inherited from") `NumericFormatProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-304 "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-305 "Direct link to Inherited from") `NumericFormatProps.size` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-306 "Direct link to Inherited from") `NumericFormatProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-307 "Direct link to Inherited from") `NumericFormatProps.spellCheck` *** ### src?[​](#src "Direct link to src?") > `optional` **src**: `string` #### Inherited from[​](#inherited-from-308 "Direct link to Inherited from") `NumericFormatProps.src` *** ### step?[​](#step "Direct link to step?") > `optional` **step**: `string` | `number` #### Inherited from[​](#inherited-from-309 "Direct link to Inherited from") `NumericFormatProps.step` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` Additional style #### Inherited from[​](#inherited-from-310 "Direct link to Inherited from") `NumericFormatProps.style` *** ### suffix?[​](#suffix "Direct link to suffix?") > `optional` **suffix**: `string` #### Inherited from[​](#inherited-from-311 "Direct link to Inherited from") `NumericFormatProps.suffix` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-312 "Direct link to Inherited from") `NumericFormatProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-313 "Direct link to Inherited from") `NumericFormatProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-314 "Direct link to Inherited from") `NumericFormatProps.tabIndex` *** ### thousandSeparator?[​](#thousandseparator "Direct link to thousandSeparator?") > `optional` **thousandSeparator**: `string` | `boolean` #### Inherited from[​](#inherited-from-315 "Direct link to Inherited from") `NumericFormatProps.thousandSeparator` *** ### thousandsGroupStyle?[​](#thousandsgroupstyle "Direct link to thousandsGroupStyle?") > `optional` **thousandsGroupStyle**: `"none"` | `"thousand"` | `"lakh"` | `"wan"` #### Inherited from[​](#inherited-from-316 "Direct link to Inherited from") `NumericFormatProps.thousandsGroupStyle` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-317 "Direct link to Inherited from") `NumericFormatProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-318 "Direct link to Inherited from") `NumericFormatProps.translate` *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `"text"` | `"tel"` | `"password"` #### Inherited from[​](#inherited-from-319 "Direct link to Inherited from") `NumericFormatProps.type` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-320 "Direct link to Inherited from") `NumericFormatProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-321 "Direct link to Inherited from") `NumericFormatProps.unselectable` *** ### value?[​](#value-1 "Direct link to value?") > `optional` **value**: `null` | `string` | `number` #### Inherited from[​](#inherited-from-322 "Direct link to Inherited from") `NumericFormatProps.value` *** ### valueIsNumericString?[​](#valueisnumericstring "Direct link to valueIsNumericString?") > `optional` **valueIsNumericString**: `boolean` #### Inherited from[​](#inherited-from-323 "Direct link to Inherited from") `NumericFormatProps.valueIsNumericString` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-324 "Direct link to Inherited from") `NumericFormatProps.vocab` *** ### width?[​](#width "Direct link to width?") > `optional` **width**: `string` | `number` #### Inherited from[​](#inherited-from-325 "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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-82 "Direct link to Inherited from") `PatternFormatProps.enterKeyHint` *** ### form?[​](#form "Direct link to form?") > `optional` **form**: `string` #### Inherited from[​](#inherited-from-83 "Direct link to Inherited from") `PatternFormatProps.form` *** ### formAction?[​](#formaction "Direct link to formAction?") > `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`> #### Inherited from[​](#inherited-from-84 "Direct link to Inherited from") `PatternFormatProps.formAction` *** ### format[​](#format "Direct link to format") > **format**: `string` #### Inherited from[​](#inherited-from-85 "Direct link to Inherited from") `PatternFormatProps.format` *** ### formEncType?[​](#formenctype "Direct link to formEncType?") > `optional` **formEncType**: `string` #### Inherited from[​](#inherited-from-86 "Direct link to Inherited from") `PatternFormatProps.formEncType` *** ### formMethod?[​](#formmethod "Direct link to formMethod?") > `optional` **formMethod**: `string` #### Inherited from[​](#inherited-from-87 "Direct link to Inherited from") `PatternFormatProps.formMethod` *** ### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?") > `optional` **formNoValidate**: `boolean` #### Inherited from[​](#inherited-from-88 "Direct link to Inherited from") `PatternFormatProps.formNoValidate` *** ### formTarget?[​](#formtarget "Direct link to formTarget?") > `optional` **formTarget**: `string` #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `PatternFormatProps.formTarget` *** ### getInputRef?[​](#getinputref "Direct link to getInputRef?") > `optional` **getInputRef**: `Ref`<`any`> | (`el`) => `void` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `PatternFormatProps.getInputRef` *** ### height?[​](#height "Direct link to height?") > `optional` **height**: `string` | `number` #### Inherited from[​](#inherited-from-91 "Direct link to Inherited from") `PatternFormatProps.height` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-92 "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-93 "Direct link to Inherited from") `PatternFormatProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `PatternFormatProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `PatternFormatProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"text"` | `"tel"` | `"url"` | `"email"` | `"numeric"` | `"decimal"` #### Inherited from[​](#inherited-from-96 "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-97 "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-30 "Direct link to See") #### Inherited from[​](#inherited-from-98 "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-99 "Direct link to Inherited from") `PatternFormatProps.isAllowed` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-100 "Direct link to Inherited from") `PatternFormatProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-101 "Direct link to Inherited from") `PatternFormatProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-102 "Direct link to Inherited from") `PatternFormatProps.itemRef` *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-103 "Direct link to Inherited from") `PatternFormatProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-104 "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-105 "Direct link to Inherited from") `PatternFormatProps.lang` *** ### list?[​](#list "Direct link to list?") > `optional` **list**: `string` #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `PatternFormatProps.list` *** ### mask?[​](#mask "Direct link to mask?") > `optional` **mask**: `string` | `string`\[] #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `PatternFormatProps.mask` *** ### max?[​](#max "Direct link to max?") > `optional` **max**: `string` | `number` #### Inherited from[​](#inherited-from-108 "Direct link to Inherited from") `PatternFormatProps.max` *** ### maxLength?[​](#maxlength "Direct link to maxLength?") > `optional` **maxLength**: `number` #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `PatternFormatProps.maxLength` *** ### min?[​](#min "Direct link to min?") > `optional` **min**: `string` | `number` #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `PatternFormatProps.min` *** ### minLength?[​](#minlength "Direct link to minLength?") > `optional` **minLength**: `number` #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `PatternFormatProps.minLength` *** ### multiple?[​](#multiple "Direct link to multiple?") > `optional` **multiple**: `boolean` #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `PatternFormatProps.multiple` *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `PatternFormatProps.name` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `PatternFormatProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `PatternFormatProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `PatternFormatProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `PatternFormatProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `PatternFormatProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `PatternFormatProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `PatternFormatProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `PatternFormatProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `PatternFormatProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `PatternFormatProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `PatternFormatProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `PatternFormatProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-126 "Direct link to Inherited from") `PatternFormatProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-127 "Direct link to Inherited from") `PatternFormatProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `PatternFormatProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `PatternFormatProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `PatternFormatProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `PatternFormatProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `PatternFormatProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-133 "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-134 "Direct link to Inherited from") `PatternFormatProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `PatternFormatProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `PatternFormatProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `PatternFormatProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `PatternFormatProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `PatternFormatProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `PatternFormatProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `PatternFormatProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `PatternFormatProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `PatternFormatProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `PatternFormatProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `PatternFormatProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `PatternFormatProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `PatternFormatProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `PatternFormatProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `PatternFormatProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `PatternFormatProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `PatternFormatProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `PatternFormatProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `PatternFormatProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `PatternFormatProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `PatternFormatProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `PatternFormatProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `PatternFormatProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `PatternFormatProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `PatternFormatProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `PatternFormatProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `PatternFormatProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `PatternFormatProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-163 "Direct link to Inherited from") `PatternFormatProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-164 "Direct link to Inherited from") `PatternFormatProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-165 "Direct link to Inherited from") `PatternFormatProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-166 "Direct link to Inherited from") `PatternFormatProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-167 "Direct link to Inherited from") `PatternFormatProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `PatternFormatProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `PatternFormatProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `PatternFormatProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `PatternFormatProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `PatternFormatProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `PatternFormatProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `PatternFormatProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `PatternFormatProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `PatternFormatProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `PatternFormatProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `PatternFormatProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `PatternFormatProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-180 "Direct link to Inherited from") `PatternFormatProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-181 "Direct link to Inherited from") `PatternFormatProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-182 "Direct link to Inherited from") `PatternFormatProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `PatternFormatProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `PatternFormatProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `PatternFormatProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-186 "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-187 "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-188 "Direct link to Inherited from") `PatternFormatProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `PatternFormatProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `PatternFormatProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `PatternFormatProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `PatternFormatProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `PatternFormatProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `PatternFormatProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `PatternFormatProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `PatternFormatProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `PatternFormatProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `PatternFormatProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `PatternFormatProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `PatternFormatProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `PatternFormatProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `PatternFormatProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `PatternFormatProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `PatternFormatProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `PatternFormatProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `PatternFormatProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `PatternFormatProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `PatternFormatProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `PatternFormatProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `PatternFormatProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `PatternFormatProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `PatternFormatProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `PatternFormatProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `PatternFormatProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `PatternFormatProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `PatternFormatProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `PatternFormatProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `PatternFormatProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `PatternFormatProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `PatternFormatProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `PatternFormatProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `PatternFormatProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `PatternFormatProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `PatternFormatProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-225 "Direct link to Inherited from") `PatternFormatProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-226 "Direct link to Inherited from") `PatternFormatProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `PatternFormatProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-228 "Direct link to Inherited from") `PatternFormatProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-229 "Direct link to Inherited from") `PatternFormatProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `PatternFormatProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `PatternFormatProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `PatternFormatProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `PatternFormatProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-234 "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-235 "Direct link to Inherited from") `PatternFormatProps.onPressEnter` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `PatternFormatProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `PatternFormatProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `PatternFormatProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `PatternFormatProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `PatternFormatProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `PatternFormatProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `PatternFormatProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `PatternFormatProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `PatternFormatProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `PatternFormatProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `PatternFormatProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `PatternFormatProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `PatternFormatProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `PatternFormatProps.onSeekingCapture` *** ### onSelect?[​](#onselect "Direct link to onSelect?") > `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `PatternFormatProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `PatternFormatProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `PatternFormatProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `PatternFormatProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `PatternFormatProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `PatternFormatProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `PatternFormatProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `PatternFormatProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `PatternFormatProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `PatternFormatProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `PatternFormatProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `PatternFormatProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `PatternFormatProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-263 "Direct link to Inherited from") `PatternFormatProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-264 "Direct link to Inherited from") `PatternFormatProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `PatternFormatProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `PatternFormatProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `PatternFormatProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `PatternFormatProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-269 "Direct link to Inherited from") `PatternFormatProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-270 "Direct link to Inherited from") `PatternFormatProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `PatternFormatProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `PatternFormatProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `PatternFormatProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `PatternFormatProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `PatternFormatProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `PatternFormatProps.onTransitionStartCapture` *** ### onValueChange?[​](#onvaluechange "Direct link to onValueChange?") > `optional` **onValueChange**: `OnValueChange` #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `PatternFormatProps.onValueChange` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-278 "Direct link to Inherited from") `PatternFormatProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-279 "Direct link to Inherited from") `PatternFormatProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `PatternFormatProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `PatternFormatProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-282 "Direct link to Inherited from") `PatternFormatProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-283 "Direct link to Inherited from") `PatternFormatProps.onWheelCapture` *** ### pattern?[​](#pattern "Direct link to pattern?") > `optional` **pattern**: `string` #### Inherited from[​](#inherited-from-284 "Direct link to Inherited from") `PatternFormatProps.pattern` *** ### patternChar?[​](#patternchar "Direct link to patternChar?") > `optional` **patternChar**: `string` #### Inherited from[​](#inherited-from-285 "Direct link to Inherited from") `PatternFormatProps.patternChar` *** ### placeholder?[​](#placeholder "Direct link to placeholder?") > `optional` **placeholder**: `string` #### Inherited from[​](#inherited-from-286 "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-287 "Direct link to Inherited from") `PatternFormatProps.plaintext` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-288 "Direct link to Inherited from") `PatternFormatProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-289 "Direct link to Inherited from") `PatternFormatProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-290 "Direct link to Inherited from") `PatternFormatProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-291 "Direct link to Inherited from") `PatternFormatProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-292 "Direct link to Inherited from") `PatternFormatProps.property` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-293 "Direct link to Inherited from") `PatternFormatProps.radioGroup` *** ### readOnly?[​](#readonly "Direct link to readOnly?") > `optional` **readOnly**: `boolean` #### Inherited from[​](#inherited-from-294 "Direct link to Inherited from") `PatternFormatProps.readOnly` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-295 "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-296 "Direct link to Inherited from") `PatternFormatProps.renderText` *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` #### Inherited from[​](#inherited-from-297 "Direct link to Inherited from") `PatternFormatProps.required` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-298 "Direct link to Inherited from") `PatternFormatProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-299 "Direct link to Inherited from") `PatternFormatProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-300 "Direct link to Inherited from") `PatternFormatProps.rev` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-301 "Direct link to Inherited from") `PatternFormatProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-302 "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-303 "Direct link to Inherited from") `PatternFormatProps.size` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-304 "Direct link to Inherited from") `PatternFormatProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-305 "Direct link to Inherited from") `PatternFormatProps.spellCheck` *** ### src?[​](#src "Direct link to src?") > `optional` **src**: `string` #### Inherited from[​](#inherited-from-306 "Direct link to Inherited from") `PatternFormatProps.src` *** ### step?[​](#step "Direct link to step?") > `optional` **step**: `string` | `number` #### Inherited from[​](#inherited-from-307 "Direct link to Inherited from") `PatternFormatProps.step` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` Additional style #### Inherited from[​](#inherited-from-308 "Direct link to Inherited from") `PatternFormatProps.style` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-309 "Direct link to Inherited from") `PatternFormatProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-310 "Direct link to Inherited from") `PatternFormatProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-311 "Direct link to Inherited from") `PatternFormatProps.tabIndex` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-312 "Direct link to Inherited from") `PatternFormatProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-313 "Direct link to Inherited from") `PatternFormatProps.translate` *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `"text"` | `"tel"` | `"password"` #### Inherited from[​](#inherited-from-314 "Direct link to Inherited from") `PatternFormatProps.type` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-315 "Direct link to Inherited from") `PatternFormatProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-316 "Direct link to Inherited from") `PatternFormatProps.unselectable` *** ### value?[​](#value-1 "Direct link to value?") > `optional` **value**: `null` | `string` | `number` #### Inherited from[​](#inherited-from-317 "Direct link to Inherited from") `PatternFormatProps.value` *** ### valueIsNumericString?[​](#valueisnumericstring "Direct link to valueIsNumericString?") > `optional` **valueIsNumericString**: `boolean` #### Inherited from[​](#inherited-from-318 "Direct link to Inherited from") `PatternFormatProps.valueIsNumericString` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-319 "Direct link to Inherited from") `PatternFormatProps.vocab` *** ### width?[​](#width "Direct link to width?") > `optional` **width**: `string` | `number` #### Inherited from[​](#inherited-from-320 "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.md)\[] 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.md) 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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-76 "Direct link to Inherited from") `NavProps.enterKeyHint` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-77 "Direct link to Inherited from") `NavProps.hidden` *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `string` #### Inherited from[​](#inherited-from-78 "Direct link to Inherited from") `NavProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-79 "Direct link to Inherited from") `NavProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-80 "Direct link to Inherited from") `NavProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"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-30 "Direct link to See") #### Inherited from[​](#inherited-from-81 "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-31 "Direct link to See") #### Inherited from[​](#inherited-from-82 "Direct link to Inherited from") `NavProps.is` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-83 "Direct link to Inherited from") `NavProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-84 "Direct link to Inherited from") `NavProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-85 "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.md)\[] Items for the tab. *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-86 "Direct link to Inherited from") `NavProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-87 "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-88 "Direct link to Inherited from") `NavProps.justified` *** ### lang?[​](#lang "Direct link to lang?") > `optional` **lang**: `string` #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `NavProps.lang` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `NavProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-91 "Direct link to Inherited from") `NavProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-92 "Direct link to Inherited from") `NavProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `NavProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `NavProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `NavProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-96 "Direct link to Inherited from") `NavProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-97 "Direct link to Inherited from") `NavProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-98 "Direct link to Inherited from") `NavProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-99 "Direct link to Inherited from") `NavProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-100 "Direct link to Inherited from") `NavProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-101 "Direct link to Inherited from") `NavProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-102 "Direct link to Inherited from") `NavProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-103 "Direct link to Inherited from") `NavProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-104 "Direct link to Inherited from") `NavProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-105 "Direct link to Inherited from") `NavProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `NavProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `NavProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-108 "Direct link to Inherited from") `NavProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `NavProps.onCanPlayThroughCapture` *** ### onChange?[​](#onchange "Direct link to onChange?") > `optional` **onChange**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `NavProps.onChange` *** ### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?") > `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `NavProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `NavProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `NavProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `NavProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `NavProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `NavProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `NavProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `NavProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `NavProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `NavProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `NavProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `NavProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `NavProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `NavProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `NavProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-126 "Direct link to Inherited from") `NavProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-127 "Direct link to Inherited from") `NavProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `NavProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `NavProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `NavProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `NavProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `NavProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `NavProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `NavProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `NavProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `NavProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `NavProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `NavProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `NavProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `NavProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `NavProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `NavProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `NavProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `NavProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `NavProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `NavProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `NavProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `NavProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `NavProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `NavProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `NavProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `NavProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `NavProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `NavProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `NavProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `NavProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `NavProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `NavProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `NavProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `NavProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `NavProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `NavProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-163 "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-164 "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-165 "Direct link to Inherited from") `NavProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-166 "Direct link to Inherited from") `NavProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-167 "Direct link to Inherited from") `NavProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `NavProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `NavProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `NavProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `NavProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `NavProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `NavProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `NavProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `NavProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `NavProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `NavProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `NavProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `NavProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-180 "Direct link to Inherited from") `NavProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-181 "Direct link to Inherited from") `NavProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-182 "Direct link to Inherited from") `NavProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `NavProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `NavProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `NavProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `NavProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `NavProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `NavProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `NavProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `NavProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `NavProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `NavProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `NavProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `NavProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `NavProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `NavProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `NavProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `NavProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `NavProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `NavProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `NavProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `NavProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `NavProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `NavProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `NavProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `NavProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `NavProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `NavProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `NavProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `NavProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `NavProps.onPointerUpCapture` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `NavProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `NavProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `NavProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `NavProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `NavProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `NavProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `NavProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `NavProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `NavProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `NavProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `NavProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `NavProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `NavProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-225 "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-226 "Direct link to Inherited from") `NavProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `NavProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-228 "Direct link to Inherited from") `NavProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-229 "Direct link to Inherited from") `NavProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `NavProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `NavProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `NavProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `NavProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `NavProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-235 "Direct link to Inherited from") `NavProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `NavProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `NavProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `NavProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `NavProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `NavProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `NavProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `NavProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `NavProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `NavProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `NavProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `NavProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `NavProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `NavProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `NavProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `NavProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `NavProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `NavProps.onTransitionStartCapture` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `NavProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `NavProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `NavProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `NavProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `NavProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `NavProps.onWheelCapture` *** ### pane[​](#pane "Direct link to pane") > **pane**: `ReactNode` Pane content for the tab. *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `NavProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `NavProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `NavProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `NavProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-263 "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-264 "Direct link to Inherited from") `NavProps.pullRight` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `NavProps.radioGroup` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `NavProps.rel` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `NavProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `NavProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-269 "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-270 "Direct link to Inherited from") `NavProps.reversed` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `NavProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-272 "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-273 "Direct link to Inherited from") `NavProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `NavProps.spellCheck` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` Additional style #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `NavProps.style` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `NavProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `NavProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-278 "Direct link to Inherited from") `NavProps.tabIndex` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-279 "Direct link to Inherited from") `NavProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `NavProps.translate` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `NavProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-282 "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-283 "Direct link to Inherited from") `NavProps.vertical` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-284 "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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-79 "Direct link to Inherited from") `InputProps.enterKeyHint` *** ### form?[​](#form "Direct link to form?") > `optional` **form**: `string` #### Inherited from[​](#inherited-from-80 "Direct link to Inherited from") `InputProps.form` *** ### formAction?[​](#formaction "Direct link to formAction?") > `optional` **formAction**: `string` | (`formData`) => `void` | `Promise`<`void`> #### Inherited from[​](#inherited-from-81 "Direct link to Inherited from") `InputProps.formAction` *** ### formEncType?[​](#formenctype "Direct link to formEncType?") > `optional` **formEncType**: `string` #### Inherited from[​](#inherited-from-82 "Direct link to Inherited from") `InputProps.formEncType` *** ### formMethod?[​](#formmethod "Direct link to formMethod?") > `optional` **formMethod**: `string` #### Inherited from[​](#inherited-from-83 "Direct link to Inherited from") `InputProps.formMethod` *** ### formNoValidate?[​](#formnovalidate "Direct link to formNoValidate?") > `optional` **formNoValidate**: `boolean` #### Inherited from[​](#inherited-from-84 "Direct link to Inherited from") `InputProps.formNoValidate` *** ### formTarget?[​](#formtarget "Direct link to formTarget?") > `optional` **formTarget**: `string` #### Inherited from[​](#inherited-from-85 "Direct link to Inherited from") `InputProps.formTarget` *** ### height?[​](#height "Direct link to height?") > `optional` **height**: `string` | `number` #### Inherited from[​](#inherited-from-86 "Direct link to Inherited from") `InputProps.height` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-87 "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-88 "Direct link to Inherited from") `InputProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `InputProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `InputProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"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-30 "Direct link to See") #### Inherited from[​](#inherited-from-91 "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-92 "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-31 "Direct link to See") #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `InputProps.is` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-94 "Direct link to Inherited from") `InputProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `InputProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-96 "Direct link to Inherited from") `InputProps.itemRef` *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-97 "Direct link to Inherited from") `InputProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-98 "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-99 "Direct link to Inherited from") `InputProps.lang` *** ### list?[​](#list "Direct link to list?") > `optional` **list**: `string` #### Inherited from[​](#inherited-from-100 "Direct link to Inherited from") `InputProps.list` *** ### max?[​](#max "Direct link to max?") > `optional` **max**: `string` | `number` #### Inherited from[​](#inherited-from-101 "Direct link to Inherited from") `InputProps.max` *** ### maxLength?[​](#maxlength "Direct link to maxLength?") > `optional` **maxLength**: `number` #### Inherited from[​](#inherited-from-102 "Direct link to Inherited from") `InputProps.maxLength` *** ### min?[​](#min "Direct link to min?") > `optional` **min**: `string` | `number` #### Inherited from[​](#inherited-from-103 "Direct link to Inherited from") `InputProps.min` *** ### minLength?[​](#minlength "Direct link to minLength?") > `optional` **minLength**: `number` #### Inherited from[​](#inherited-from-104 "Direct link to Inherited from") `InputProps.minLength` *** ### multiple?[​](#multiple "Direct link to multiple?") > `optional` **multiple**: `boolean` #### Inherited from[​](#inherited-from-105 "Direct link to Inherited from") `InputProps.multiple` *** ### name?[​](#name "Direct link to name?") > `optional` **name**: `string` #### Inherited from[​](#inherited-from-106 "Direct link to Inherited from") `InputProps.name` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-107 "Direct link to Inherited from") `InputProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-108 "Direct link to Inherited from") `InputProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `InputProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `InputProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `InputProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `InputProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `InputProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `InputProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `InputProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `InputProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `InputProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `InputProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `InputProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `InputProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `InputProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `InputProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `InputProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `InputProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `InputProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-126 "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-127 "Direct link to Inherited from") `InputProps.onChange` *** ### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?") > `optional` **onChangeCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-128 "Direct link to Inherited from") `InputProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-129 "Direct link to Inherited from") `InputProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `InputProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `InputProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `InputProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `InputProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `InputProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `InputProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `InputProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `InputProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `InputProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `InputProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `InputProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `InputProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `InputProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `InputProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `InputProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `InputProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `InputProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `InputProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `InputProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `InputProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `InputProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `InputProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `InputProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `InputProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `InputProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `InputProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `InputProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `InputProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `InputProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `InputProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `InputProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `InputProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `InputProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-163 "Direct link to Inherited from") `InputProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-164 "Direct link to Inherited from") `InputProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-165 "Direct link to Inherited from") `InputProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-166 "Direct link to Inherited from") `InputProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-167 "Direct link to Inherited from") `InputProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `InputProps.onEndedCapture` *** ### onError?[​](#onerror "Direct link to onError?") > `optional` **onError**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `InputProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-170 "Direct link to Inherited from") `InputProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-171 "Direct link to Inherited from") `InputProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `InputProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `InputProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `InputProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `InputProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `InputProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `InputProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `InputProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `InputProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-180 "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-181 "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-182 "Direct link to Inherited from") `InputProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-183 "Direct link to Inherited from") `InputProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-184 "Direct link to Inherited from") `InputProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `InputProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `InputProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `InputProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `InputProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `InputProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `InputProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `InputProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `InputProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `InputProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `InputProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `InputProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `InputProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `InputProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `InputProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `InputProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `InputProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `InputProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `InputProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `InputProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `InputProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `InputProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `InputProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `InputProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `InputProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `InputProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `InputProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `InputProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `InputProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `InputProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `InputProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `InputProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `InputProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `InputProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `InputProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `InputProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `InputProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `InputProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `InputProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `InputProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `InputProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-225 "Direct link to Inherited from") `InputProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-226 "Direct link to Inherited from") `InputProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `InputProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-228 "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-229 "Direct link to Inherited from") `InputProps.onPressEnter` *** ### onProgress?[​](#onprogress "Direct link to onProgress?") > `optional` **onProgress**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-230 "Direct link to Inherited from") `InputProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-231 "Direct link to Inherited from") `InputProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-232 "Direct link to Inherited from") `InputProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `InputProps.onRateChangeCapture` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `InputProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-235 "Direct link to Inherited from") `InputProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-236 "Direct link to Inherited from") `InputProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `InputProps.onResizeCapture` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `InputProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `InputProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `InputProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-241 "Direct link to Inherited from") `InputProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `InputProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `InputProps.onSeekingCapture` *** ### onSelect?[​](#onselect "Direct link to onSelect?") > `optional` **onSelect**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `InputProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `InputProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `InputProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `InputProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `InputProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `InputProps.onSubmitCapture` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `InputProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `InputProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `InputProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-253 "Direct link to Inherited from") `InputProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-254 "Direct link to Inherited from") `InputProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `InputProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `InputProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `InputProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `InputProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `InputProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `InputProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `InputProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `InputProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-263 "Direct link to Inherited from") `InputProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-264 "Direct link to Inherited from") `InputProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `InputProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `InputProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `InputProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `InputProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-269 "Direct link to Inherited from") `InputProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-270 "Direct link to Inherited from") `InputProps.onTransitionStartCapture` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `InputProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `InputProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `InputProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `InputProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-275 "Direct link to Inherited from") `InputProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-276 "Direct link to Inherited from") `InputProps.onWheelCapture` *** ### pattern?[​](#pattern "Direct link to pattern?") > `optional` **pattern**: `string` #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `InputProps.pattern` *** ### placeholder?[​](#placeholder "Direct link to placeholder?") > `optional` **placeholder**: `string` #### Inherited from[​](#inherited-from-278 "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-279 "Direct link to Inherited from") `InputProps.plaintext` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `InputProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `InputProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-282 "Direct link to Inherited from") `InputProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-283 "Direct link to Inherited from") `InputProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-284 "Direct link to Inherited from") `InputProps.property` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-285 "Direct link to Inherited from") `InputProps.radioGroup` *** ### readOnly?[​](#readonly "Direct link to readOnly?") > `optional` **readOnly**: `boolean` #### Inherited from[​](#inherited-from-286 "Direct link to Inherited from") `InputProps.readOnly` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-287 "Direct link to Inherited from") `InputProps.rel` *** ### required?[​](#required "Direct link to required?") > `optional` **required**: `boolean` #### Inherited from[​](#inherited-from-288 "Direct link to Inherited from") `InputProps.required` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-289 "Direct link to Inherited from") `InputProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-290 "Direct link to Inherited from") `InputProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-291 "Direct link to Inherited from") `InputProps.rev` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-292 "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-293 "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-294 "Direct link to Inherited from") `InputProps.size` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-295 "Direct link to Inherited from") `InputProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-296 "Direct link to Inherited from") `InputProps.spellCheck` *** ### src?[​](#src "Direct link to src?") > `optional` **src**: `string` #### Inherited from[​](#inherited-from-297 "Direct link to Inherited from") `InputProps.src` *** ### step?[​](#step "Direct link to step?") > `optional` **step**: `string` | `number` #### Inherited from[​](#inherited-from-298 "Direct link to Inherited from") `InputProps.step` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` Additional style #### Inherited from[​](#inherited-from-299 "Direct link to Inherited from") `InputProps.style` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-300 "Direct link to Inherited from") `InputProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-301 "Direct link to Inherited from") `InputProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-302 "Direct link to Inherited from") `InputProps.tabIndex` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-303 "Direct link to Inherited from") `InputProps.title` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-304 "Direct link to Inherited from") `InputProps.translate` *** ### type?[​](#type "Direct link to type?") > `optional` **type**: `string` The HTML input type #### Inherited from[​](#inherited-from-305 "Direct link to Inherited from") `InputProps.type` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-306 "Direct link to Inherited from") `InputProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-307 "Direct link to Inherited from") `InputProps.unselectable` *** ### value?[​](#value "Direct link to value?") > `optional` **value**: `string` | `number` | readonly `string`\[] #### Inherited from[​](#inherited-from-308 "Direct link to Inherited from") `InputProps.value` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-309 "Direct link to Inherited from") `InputProps.vocab` *** ### width?[​](#width "Direct link to width?") > `optional` **width**: `string` | `number` #### Inherited from[​](#inherited-from-310 "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") #### 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.md) ## 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.md).[`children`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps.md#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.md).[`className`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/WrapperProps.md#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**: `"inline"` | `"none"` | `"list"` | `"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**: `"none"` | `"link"` | `"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**: `Booleanish` | `"inherit"` | `"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**: `"done"` | `"search"` | `"enter"` | `"go"` | `"next"` | `"previous"` | `"send"` #### Inherited from[​](#inherited-from-85 "Direct link to Inherited from") `UploaderProps.enterKeyHint` *** ### fileList?[​](#filelist "Direct link to fileList?") > `optional` **fileList**: `FileType`\[] List of uploaded files （Controlled） #### Inherited from[​](#inherited-from-86 "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-87 "Direct link to Inherited from") `UploaderProps.fileListVisible` *** ### headers?[​](#headers "Direct link to headers?") > `optional` **headers**: `any` Set Upload request Header #### Inherited from[​](#inherited-from-88 "Direct link to Inherited from") `UploaderProps.headers` *** ### hidden?[​](#hidden "Direct link to hidden?") > `optional` **hidden**: `boolean` #### Inherited from[​](#inherited-from-89 "Direct link to Inherited from") `UploaderProps.hidden` *** ### href?[​](#href "Direct link to href?") > `optional` **href**: `string` Providing a `href` will render an `` element, *styled* as a button #### Inherited from[​](#inherited-from-90 "Direct link to Inherited from") `UploaderProps.href` *** ### id?[​](#id "Direct link to id?") > `optional` **id**: `string` #### Inherited from[​](#inherited-from-91 "Direct link to Inherited from") `UploaderProps.id` *** ### inert?[​](#inert "Direct link to inert?") > `optional` **inert**: `boolean` #### See[​](#see-29 "Direct link to See") #### Inherited from[​](#inherited-from-92 "Direct link to Inherited from") `UploaderProps.inert` *** ### inlist?[​](#inlist "Direct link to inlist?") > `optional` **inlist**: `any` #### Inherited from[​](#inherited-from-93 "Direct link to Inherited from") `UploaderProps.inlist` *** ### inputMode?[​](#inputmode "Direct link to inputMode?") > `optional` **inputMode**: `"none"` | `"search"` | `"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-30 "Direct link to See") #### Inherited from[​](#inherited-from-94 "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-31 "Direct link to See") #### Inherited from[​](#inherited-from-95 "Direct link to Inherited from") `UploaderProps.is` *** ### itemID?[​](#itemid "Direct link to itemID?") > `optional` **itemID**: `string` #### Inherited from[​](#inherited-from-96 "Direct link to Inherited from") `UploaderProps.itemID` *** ### itemProp?[​](#itemprop "Direct link to itemProp?") > `optional` **itemProp**: `string` #### Inherited from[​](#inherited-from-97 "Direct link to Inherited from") `UploaderProps.itemProp` *** ### itemRef?[​](#itemref "Direct link to itemRef?") > `optional` **itemRef**: `string` #### Inherited from[​](#inherited-from-98 "Direct link to Inherited from") `UploaderProps.itemRef` *** ### itemScope?[​](#itemscope "Direct link to itemScope?") > `optional` **itemScope**: `boolean` #### Inherited from[​](#inherited-from-99 "Direct link to Inherited from") `UploaderProps.itemScope` *** ### itemType?[​](#itemtype "Direct link to itemType?") > `optional` **itemType**: `string` #### Inherited from[​](#inherited-from-100 "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-101 "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-102 "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-103 "Direct link to Inherited from") `UploaderProps.loading` *** ### locale?[​](#locale "Direct link to locale?") > `optional` **locale**: `UploaderLocale` Custom locale #### Inherited from[​](#inherited-from-104 "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-105 "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-106 "Direct link to Inherited from") `UploaderProps.method` *** ### multiple?[​](#multiple "Direct link to multiple?") > `optional` **multiple**: `boolean` Allow multiple file uploads #### Inherited from[​](#inherited-from-107 "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-108 "Direct link to Inherited from") `UploaderProps.name` *** ### nonce?[​](#nonce "Direct link to nonce?") > `optional` **nonce**: `string` #### Inherited from[​](#inherited-from-109 "Direct link to Inherited from") `UploaderProps.nonce` *** ### onAbort?[​](#onabort "Direct link to onAbort?") > `optional` **onAbort**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-110 "Direct link to Inherited from") `UploaderProps.onAbort` *** ### onAbortCapture?[​](#onabortcapture "Direct link to onAbortCapture?") > `optional` **onAbortCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-111 "Direct link to Inherited from") `UploaderProps.onAbortCapture` *** ### onAnimationEnd?[​](#onanimationend "Direct link to onAnimationEnd?") > `optional` **onAnimationEnd**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-112 "Direct link to Inherited from") `UploaderProps.onAnimationEnd` *** ### onAnimationEndCapture?[​](#onanimationendcapture "Direct link to onAnimationEndCapture?") > `optional` **onAnimationEndCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-113 "Direct link to Inherited from") `UploaderProps.onAnimationEndCapture` *** ### onAnimationIteration?[​](#onanimationiteration "Direct link to onAnimationIteration?") > `optional` **onAnimationIteration**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-114 "Direct link to Inherited from") `UploaderProps.onAnimationIteration` *** ### onAnimationIterationCapture?[​](#onanimationiterationcapture "Direct link to onAnimationIterationCapture?") > `optional` **onAnimationIterationCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-115 "Direct link to Inherited from") `UploaderProps.onAnimationIterationCapture` *** ### onAnimationStart?[​](#onanimationstart "Direct link to onAnimationStart?") > `optional` **onAnimationStart**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-116 "Direct link to Inherited from") `UploaderProps.onAnimationStart` *** ### onAnimationStartCapture?[​](#onanimationstartcapture "Direct link to onAnimationStartCapture?") > `optional` **onAnimationStartCapture**: `AnimationEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-117 "Direct link to Inherited from") `UploaderProps.onAnimationStartCapture` *** ### onAuxClick?[​](#onauxclick "Direct link to onAuxClick?") > `optional` **onAuxClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-118 "Direct link to Inherited from") `UploaderProps.onAuxClick` *** ### onAuxClickCapture?[​](#onauxclickcapture "Direct link to onAuxClickCapture?") > `optional` **onAuxClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-119 "Direct link to Inherited from") `UploaderProps.onAuxClickCapture` *** ### onBeforeInput?[​](#onbeforeinput "Direct link to onBeforeInput?") > `optional` **onBeforeInput**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-120 "Direct link to Inherited from") `UploaderProps.onBeforeInput` *** ### onBeforeInputCapture?[​](#onbeforeinputcapture "Direct link to onBeforeInputCapture?") > `optional` **onBeforeInputCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-121 "Direct link to Inherited from") `UploaderProps.onBeforeInputCapture` *** ### onBeforeToggle?[​](#onbeforetoggle "Direct link to onBeforeToggle?") > `optional` **onBeforeToggle**: `ToggleEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-122 "Direct link to Inherited from") `UploaderProps.onBeforeToggle` *** ### onBlur?[​](#onblur "Direct link to onBlur?") > `optional` **onBlur**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-123 "Direct link to Inherited from") `UploaderProps.onBlur` *** ### onBlurCapture?[​](#onblurcapture "Direct link to onBlurCapture?") > `optional` **onBlurCapture**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-124 "Direct link to Inherited from") `UploaderProps.onBlurCapture` *** ### onCanPlay?[​](#oncanplay "Direct link to onCanPlay?") > `optional` **onCanPlay**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-125 "Direct link to Inherited from") `UploaderProps.onCanPlay` *** ### onCanPlayCapture?[​](#oncanplaycapture "Direct link to onCanPlayCapture?") > `optional` **onCanPlayCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-126 "Direct link to Inherited from") `UploaderProps.onCanPlayCapture` *** ### onCanPlayThrough?[​](#oncanplaythrough "Direct link to onCanPlayThrough?") > `optional` **onCanPlayThrough**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-127 "Direct link to Inherited from") `UploaderProps.onCanPlayThrough` *** ### onCanPlayThroughCapture?[​](#oncanplaythroughcapture "Direct link to onCanPlayThroughCapture?") > `optional` **onCanPlayThroughCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-128 "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-129 "Direct link to Inherited from") `UploaderProps.onChange` *** ### onChangeCapture?[​](#onchangecapture "Direct link to onChangeCapture?") > `optional` **onChangeCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-130 "Direct link to Inherited from") `UploaderProps.onChangeCapture` *** ### onClick?[​](#onclick "Direct link to onClick?") > `optional` **onClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-131 "Direct link to Inherited from") `UploaderProps.onClick` *** ### onClickCapture?[​](#onclickcapture "Direct link to onClickCapture?") > `optional` **onClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-132 "Direct link to Inherited from") `UploaderProps.onClickCapture` *** ### onCompositionEnd?[​](#oncompositionend "Direct link to onCompositionEnd?") > `optional` **onCompositionEnd**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-133 "Direct link to Inherited from") `UploaderProps.onCompositionEnd` *** ### onCompositionEndCapture?[​](#oncompositionendcapture "Direct link to onCompositionEndCapture?") > `optional` **onCompositionEndCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-134 "Direct link to Inherited from") `UploaderProps.onCompositionEndCapture` *** ### onCompositionStart?[​](#oncompositionstart "Direct link to onCompositionStart?") > `optional` **onCompositionStart**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-135 "Direct link to Inherited from") `UploaderProps.onCompositionStart` *** ### onCompositionStartCapture?[​](#oncompositionstartcapture "Direct link to onCompositionStartCapture?") > `optional` **onCompositionStartCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-136 "Direct link to Inherited from") `UploaderProps.onCompositionStartCapture` *** ### onCompositionUpdate?[​](#oncompositionupdate "Direct link to onCompositionUpdate?") > `optional` **onCompositionUpdate**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-137 "Direct link to Inherited from") `UploaderProps.onCompositionUpdate` *** ### onCompositionUpdateCapture?[​](#oncompositionupdatecapture "Direct link to onCompositionUpdateCapture?") > `optional` **onCompositionUpdateCapture**: `CompositionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-138 "Direct link to Inherited from") `UploaderProps.onCompositionUpdateCapture` *** ### onContextMenu?[​](#oncontextmenu "Direct link to onContextMenu?") > `optional` **onContextMenu**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-139 "Direct link to Inherited from") `UploaderProps.onContextMenu` *** ### onContextMenuCapture?[​](#oncontextmenucapture "Direct link to onContextMenuCapture?") > `optional` **onContextMenuCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-140 "Direct link to Inherited from") `UploaderProps.onContextMenuCapture` *** ### onCopy?[​](#oncopy "Direct link to onCopy?") > `optional` **onCopy**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-141 "Direct link to Inherited from") `UploaderProps.onCopy` *** ### onCopyCapture?[​](#oncopycapture "Direct link to onCopyCapture?") > `optional` **onCopyCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-142 "Direct link to Inherited from") `UploaderProps.onCopyCapture` *** ### onCut?[​](#oncut "Direct link to onCut?") > `optional` **onCut**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-143 "Direct link to Inherited from") `UploaderProps.onCut` *** ### onCutCapture?[​](#oncutcapture "Direct link to onCutCapture?") > `optional` **onCutCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-144 "Direct link to Inherited from") `UploaderProps.onCutCapture` *** ### onDoubleClick?[​](#ondoubleclick "Direct link to onDoubleClick?") > `optional` **onDoubleClick**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-145 "Direct link to Inherited from") `UploaderProps.onDoubleClick` *** ### onDoubleClickCapture?[​](#ondoubleclickcapture "Direct link to onDoubleClickCapture?") > `optional` **onDoubleClickCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-146 "Direct link to Inherited from") `UploaderProps.onDoubleClickCapture` *** ### onDrag?[​](#ondrag "Direct link to onDrag?") > `optional` **onDrag**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-147 "Direct link to Inherited from") `UploaderProps.onDrag` *** ### onDragCapture?[​](#ondragcapture "Direct link to onDragCapture?") > `optional` **onDragCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-148 "Direct link to Inherited from") `UploaderProps.onDragCapture` *** ### onDragEnd?[​](#ondragend "Direct link to onDragEnd?") > `optional` **onDragEnd**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-149 "Direct link to Inherited from") `UploaderProps.onDragEnd` *** ### onDragEndCapture?[​](#ondragendcapture "Direct link to onDragEndCapture?") > `optional` **onDragEndCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-150 "Direct link to Inherited from") `UploaderProps.onDragEndCapture` *** ### onDragEnter?[​](#ondragenter "Direct link to onDragEnter?") > `optional` **onDragEnter**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-151 "Direct link to Inherited from") `UploaderProps.onDragEnter` *** ### onDragEnterCapture?[​](#ondragentercapture "Direct link to onDragEnterCapture?") > `optional` **onDragEnterCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-152 "Direct link to Inherited from") `UploaderProps.onDragEnterCapture` *** ### onDragExit?[​](#ondragexit "Direct link to onDragExit?") > `optional` **onDragExit**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-153 "Direct link to Inherited from") `UploaderProps.onDragExit` *** ### onDragExitCapture?[​](#ondragexitcapture "Direct link to onDragExitCapture?") > `optional` **onDragExitCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-154 "Direct link to Inherited from") `UploaderProps.onDragExitCapture` *** ### onDragLeave?[​](#ondragleave "Direct link to onDragLeave?") > `optional` **onDragLeave**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-155 "Direct link to Inherited from") `UploaderProps.onDragLeave` *** ### onDragLeaveCapture?[​](#ondragleavecapture "Direct link to onDragLeaveCapture?") > `optional` **onDragLeaveCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-156 "Direct link to Inherited from") `UploaderProps.onDragLeaveCapture` *** ### onDragOver?[​](#ondragover "Direct link to onDragOver?") > `optional` **onDragOver**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-157 "Direct link to Inherited from") `UploaderProps.onDragOver` *** ### onDragOverCapture?[​](#ondragovercapture "Direct link to onDragOverCapture?") > `optional` **onDragOverCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-158 "Direct link to Inherited from") `UploaderProps.onDragOverCapture` *** ### onDragStart?[​](#ondragstart "Direct link to onDragStart?") > `optional` **onDragStart**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-159 "Direct link to Inherited from") `UploaderProps.onDragStart` *** ### onDragStartCapture?[​](#ondragstartcapture "Direct link to onDragStartCapture?") > `optional` **onDragStartCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-160 "Direct link to Inherited from") `UploaderProps.onDragStartCapture` *** ### onDrop?[​](#ondrop "Direct link to onDrop?") > `optional` **onDrop**: `DragEventHandler`<`HTMLInputElement`> #### Inherited from[​](#inherited-from-161 "Direct link to Inherited from") `UploaderProps.onDrop` *** ### onDropCapture?[​](#ondropcapture "Direct link to onDropCapture?") > `optional` **onDropCapture**: `DragEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-162 "Direct link to Inherited from") `UploaderProps.onDropCapture` *** ### onDurationChange?[​](#ondurationchange "Direct link to onDurationChange?") > `optional` **onDurationChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-163 "Direct link to Inherited from") `UploaderProps.onDurationChange` *** ### onDurationChangeCapture?[​](#ondurationchangecapture "Direct link to onDurationChangeCapture?") > `optional` **onDurationChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-164 "Direct link to Inherited from") `UploaderProps.onDurationChangeCapture` *** ### onEmptied?[​](#onemptied "Direct link to onEmptied?") > `optional` **onEmptied**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-165 "Direct link to Inherited from") `UploaderProps.onEmptied` *** ### onEmptiedCapture?[​](#onemptiedcapture "Direct link to onEmptiedCapture?") > `optional` **onEmptiedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-166 "Direct link to Inherited from") `UploaderProps.onEmptiedCapture` *** ### onEncrypted?[​](#onencrypted "Direct link to onEncrypted?") > `optional` **onEncrypted**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-167 "Direct link to Inherited from") `UploaderProps.onEncrypted` *** ### onEncryptedCapture?[​](#onencryptedcapture "Direct link to onEncryptedCapture?") > `optional` **onEncryptedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-168 "Direct link to Inherited from") `UploaderProps.onEncryptedCapture` *** ### onEnded?[​](#onended "Direct link to onEnded?") > `optional` **onEnded**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-169 "Direct link to Inherited from") `UploaderProps.onEnded` *** ### onEndedCapture?[​](#onendedcapture "Direct link to onEndedCapture?") > `optional` **onEndedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-170 "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-171 "Direct link to Inherited from") `UploaderProps.onError` *** ### onErrorCapture?[​](#onerrorcapture "Direct link to onErrorCapture?") > `optional` **onErrorCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-172 "Direct link to Inherited from") `UploaderProps.onErrorCapture` *** ### onFocus?[​](#onfocus "Direct link to onFocus?") > `optional` **onFocus**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-173 "Direct link to Inherited from") `UploaderProps.onFocus` *** ### onFocusCapture?[​](#onfocuscapture "Direct link to onFocusCapture?") > `optional` **onFocusCapture**: `FocusEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-174 "Direct link to Inherited from") `UploaderProps.onFocusCapture` *** ### onGotPointerCapture?[​](#ongotpointercapture "Direct link to onGotPointerCapture?") > `optional` **onGotPointerCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-175 "Direct link to Inherited from") `UploaderProps.onGotPointerCapture` *** ### onGotPointerCaptureCapture?[​](#ongotpointercapturecapture "Direct link to onGotPointerCaptureCapture?") > `optional` **onGotPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-176 "Direct link to Inherited from") `UploaderProps.onGotPointerCaptureCapture` *** ### onInput?[​](#oninput "Direct link to onInput?") > `optional` **onInput**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-177 "Direct link to Inherited from") `UploaderProps.onInput` *** ### onInputCapture?[​](#oninputcapture "Direct link to onInputCapture?") > `optional` **onInputCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-178 "Direct link to Inherited from") `UploaderProps.onInputCapture` *** ### onInvalid?[​](#oninvalid "Direct link to onInvalid?") > `optional` **onInvalid**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-179 "Direct link to Inherited from") `UploaderProps.onInvalid` *** ### onInvalidCapture?[​](#oninvalidcapture "Direct link to onInvalidCapture?") > `optional` **onInvalidCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-180 "Direct link to Inherited from") `UploaderProps.onInvalidCapture` *** ### onKeyDown?[​](#onkeydown "Direct link to onKeyDown?") > `optional` **onKeyDown**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-181 "Direct link to Inherited from") `UploaderProps.onKeyDown` *** ### onKeyDownCapture?[​](#onkeydowncapture "Direct link to onKeyDownCapture?") > `optional` **onKeyDownCapture**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-182 "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-183 "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-184 "Direct link to Inherited from") `UploaderProps.onKeyPressCapture` *** ### onKeyUp?[​](#onkeyup "Direct link to onKeyUp?") > `optional` **onKeyUp**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-185 "Direct link to Inherited from") `UploaderProps.onKeyUp` *** ### onKeyUpCapture?[​](#onkeyupcapture "Direct link to onKeyUpCapture?") > `optional` **onKeyUpCapture**: `KeyboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-186 "Direct link to Inherited from") `UploaderProps.onKeyUpCapture` *** ### onLoad?[​](#onload "Direct link to onLoad?") > `optional` **onLoad**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-187 "Direct link to Inherited from") `UploaderProps.onLoad` *** ### onLoadCapture?[​](#onloadcapture "Direct link to onLoadCapture?") > `optional` **onLoadCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-188 "Direct link to Inherited from") `UploaderProps.onLoadCapture` *** ### onLoadedData?[​](#onloadeddata "Direct link to onLoadedData?") > `optional` **onLoadedData**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-189 "Direct link to Inherited from") `UploaderProps.onLoadedData` *** ### onLoadedDataCapture?[​](#onloadeddatacapture "Direct link to onLoadedDataCapture?") > `optional` **onLoadedDataCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-190 "Direct link to Inherited from") `UploaderProps.onLoadedDataCapture` *** ### onLoadedMetadata?[​](#onloadedmetadata "Direct link to onLoadedMetadata?") > `optional` **onLoadedMetadata**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-191 "Direct link to Inherited from") `UploaderProps.onLoadedMetadata` *** ### onLoadedMetadataCapture?[​](#onloadedmetadatacapture "Direct link to onLoadedMetadataCapture?") > `optional` **onLoadedMetadataCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-192 "Direct link to Inherited from") `UploaderProps.onLoadedMetadataCapture` *** ### onLoadStart?[​](#onloadstart "Direct link to onLoadStart?") > `optional` **onLoadStart**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-193 "Direct link to Inherited from") `UploaderProps.onLoadStart` *** ### onLoadStartCapture?[​](#onloadstartcapture "Direct link to onLoadStartCapture?") > `optional` **onLoadStartCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-194 "Direct link to Inherited from") `UploaderProps.onLoadStartCapture` *** ### onLostPointerCapture?[​](#onlostpointercapture "Direct link to onLostPointerCapture?") > `optional` **onLostPointerCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-195 "Direct link to Inherited from") `UploaderProps.onLostPointerCapture` *** ### onLostPointerCaptureCapture?[​](#onlostpointercapturecapture "Direct link to onLostPointerCaptureCapture?") > `optional` **onLostPointerCaptureCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-196 "Direct link to Inherited from") `UploaderProps.onLostPointerCaptureCapture` *** ### onMouseDown?[​](#onmousedown "Direct link to onMouseDown?") > `optional` **onMouseDown**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-197 "Direct link to Inherited from") `UploaderProps.onMouseDown` *** ### onMouseDownCapture?[​](#onmousedowncapture "Direct link to onMouseDownCapture?") > `optional` **onMouseDownCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-198 "Direct link to Inherited from") `UploaderProps.onMouseDownCapture` *** ### onMouseEnter?[​](#onmouseenter "Direct link to onMouseEnter?") > `optional` **onMouseEnter**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-199 "Direct link to Inherited from") `UploaderProps.onMouseEnter` *** ### onMouseLeave?[​](#onmouseleave "Direct link to onMouseLeave?") > `optional` **onMouseLeave**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-200 "Direct link to Inherited from") `UploaderProps.onMouseLeave` *** ### onMouseMove?[​](#onmousemove "Direct link to onMouseMove?") > `optional` **onMouseMove**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-201 "Direct link to Inherited from") `UploaderProps.onMouseMove` *** ### onMouseMoveCapture?[​](#onmousemovecapture "Direct link to onMouseMoveCapture?") > `optional` **onMouseMoveCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-202 "Direct link to Inherited from") `UploaderProps.onMouseMoveCapture` *** ### onMouseOut?[​](#onmouseout "Direct link to onMouseOut?") > `optional` **onMouseOut**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-203 "Direct link to Inherited from") `UploaderProps.onMouseOut` *** ### onMouseOutCapture?[​](#onmouseoutcapture "Direct link to onMouseOutCapture?") > `optional` **onMouseOutCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-204 "Direct link to Inherited from") `UploaderProps.onMouseOutCapture` *** ### onMouseOver?[​](#onmouseover "Direct link to onMouseOver?") > `optional` **onMouseOver**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-205 "Direct link to Inherited from") `UploaderProps.onMouseOver` *** ### onMouseOverCapture?[​](#onmouseovercapture "Direct link to onMouseOverCapture?") > `optional` **onMouseOverCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-206 "Direct link to Inherited from") `UploaderProps.onMouseOverCapture` *** ### onMouseUp?[​](#onmouseup "Direct link to onMouseUp?") > `optional` **onMouseUp**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-207 "Direct link to Inherited from") `UploaderProps.onMouseUp` *** ### onMouseUpCapture?[​](#onmouseupcapture "Direct link to onMouseUpCapture?") > `optional` **onMouseUpCapture**: `MouseEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-208 "Direct link to Inherited from") `UploaderProps.onMouseUpCapture` *** ### onPaste?[​](#onpaste "Direct link to onPaste?") > `optional` **onPaste**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-209 "Direct link to Inherited from") `UploaderProps.onPaste` *** ### onPasteCapture?[​](#onpastecapture "Direct link to onPasteCapture?") > `optional` **onPasteCapture**: `ClipboardEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-210 "Direct link to Inherited from") `UploaderProps.onPasteCapture` *** ### onPause?[​](#onpause "Direct link to onPause?") > `optional` **onPause**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-211 "Direct link to Inherited from") `UploaderProps.onPause` *** ### onPauseCapture?[​](#onpausecapture "Direct link to onPauseCapture?") > `optional` **onPauseCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-212 "Direct link to Inherited from") `UploaderProps.onPauseCapture` *** ### onPlay?[​](#onplay "Direct link to onPlay?") > `optional` **onPlay**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-213 "Direct link to Inherited from") `UploaderProps.onPlay` *** ### onPlayCapture?[​](#onplaycapture "Direct link to onPlayCapture?") > `optional` **onPlayCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-214 "Direct link to Inherited from") `UploaderProps.onPlayCapture` *** ### onPlaying?[​](#onplaying "Direct link to onPlaying?") > `optional` **onPlaying**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-215 "Direct link to Inherited from") `UploaderProps.onPlaying` *** ### onPlayingCapture?[​](#onplayingcapture "Direct link to onPlayingCapture?") > `optional` **onPlayingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-216 "Direct link to Inherited from") `UploaderProps.onPlayingCapture` *** ### onPointerCancel?[​](#onpointercancel "Direct link to onPointerCancel?") > `optional` **onPointerCancel**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-217 "Direct link to Inherited from") `UploaderProps.onPointerCancel` *** ### onPointerCancelCapture?[​](#onpointercancelcapture "Direct link to onPointerCancelCapture?") > `optional` **onPointerCancelCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-218 "Direct link to Inherited from") `UploaderProps.onPointerCancelCapture` *** ### onPointerDown?[​](#onpointerdown "Direct link to onPointerDown?") > `optional` **onPointerDown**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-219 "Direct link to Inherited from") `UploaderProps.onPointerDown` *** ### onPointerDownCapture?[​](#onpointerdowncapture "Direct link to onPointerDownCapture?") > `optional` **onPointerDownCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-220 "Direct link to Inherited from") `UploaderProps.onPointerDownCapture` *** ### onPointerEnter?[​](#onpointerenter "Direct link to onPointerEnter?") > `optional` **onPointerEnter**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-221 "Direct link to Inherited from") `UploaderProps.onPointerEnter` *** ### onPointerLeave?[​](#onpointerleave "Direct link to onPointerLeave?") > `optional` **onPointerLeave**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-222 "Direct link to Inherited from") `UploaderProps.onPointerLeave` *** ### onPointerMove?[​](#onpointermove "Direct link to onPointerMove?") > `optional` **onPointerMove**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-223 "Direct link to Inherited from") `UploaderProps.onPointerMove` *** ### onPointerMoveCapture?[​](#onpointermovecapture "Direct link to onPointerMoveCapture?") > `optional` **onPointerMoveCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-224 "Direct link to Inherited from") `UploaderProps.onPointerMoveCapture` *** ### onPointerOut?[​](#onpointerout "Direct link to onPointerOut?") > `optional` **onPointerOut**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-225 "Direct link to Inherited from") `UploaderProps.onPointerOut` *** ### onPointerOutCapture?[​](#onpointeroutcapture "Direct link to onPointerOutCapture?") > `optional` **onPointerOutCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-226 "Direct link to Inherited from") `UploaderProps.onPointerOutCapture` *** ### onPointerOver?[​](#onpointerover "Direct link to onPointerOver?") > `optional` **onPointerOver**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-227 "Direct link to Inherited from") `UploaderProps.onPointerOver` *** ### onPointerOverCapture?[​](#onpointerovercapture "Direct link to onPointerOverCapture?") > `optional` **onPointerOverCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-228 "Direct link to Inherited from") `UploaderProps.onPointerOverCapture` *** ### onPointerUp?[​](#onpointerup "Direct link to onPointerUp?") > `optional` **onPointerUp**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-229 "Direct link to Inherited from") `UploaderProps.onPointerUp` *** ### onPointerUpCapture?[​](#onpointerupcapture "Direct link to onPointerUpCapture?") > `optional` **onPointerUpCapture**: `PointerEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-230 "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-231 "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-232 "Direct link to Inherited from") `UploaderProps.onProgress` *** ### onProgressCapture?[​](#onprogresscapture "Direct link to onProgressCapture?") > `optional` **onProgressCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-233 "Direct link to Inherited from") `UploaderProps.onProgressCapture` *** ### onRateChange?[​](#onratechange "Direct link to onRateChange?") > `optional` **onRateChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-234 "Direct link to Inherited from") `UploaderProps.onRateChange` *** ### onRateChangeCapture?[​](#onratechangecapture "Direct link to onRateChangeCapture?") > `optional` **onRateChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-235 "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-236 "Direct link to Inherited from") `UploaderProps.onRemove` *** ### onReset?[​](#onreset "Direct link to onReset?") > `optional` **onReset**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-237 "Direct link to Inherited from") `UploaderProps.onReset` *** ### onResetCapture?[​](#onresetcapture "Direct link to onResetCapture?") > `optional` **onResetCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-238 "Direct link to Inherited from") `UploaderProps.onResetCapture` *** ### onResize?[​](#onresize "Direct link to onResize?") > `optional` **onResize**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-239 "Direct link to Inherited from") `UploaderProps.onResize` *** ### onResizeCapture?[​](#onresizecapture "Direct link to onResizeCapture?") > `optional` **onResizeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-240 "Direct link to Inherited from") `UploaderProps.onResizeCapture` *** ### 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-241 "Direct link to Inherited from") `UploaderProps.onReupload` *** ### onScroll?[​](#onscroll "Direct link to onScroll?") > `optional` **onScroll**: `UIEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-242 "Direct link to Inherited from") `UploaderProps.onScroll` *** ### onScrollCapture?[​](#onscrollcapture "Direct link to onScrollCapture?") > `optional` **onScrollCapture**: `UIEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-243 "Direct link to Inherited from") `UploaderProps.onScrollCapture` *** ### onSeeked?[​](#onseeked "Direct link to onSeeked?") > `optional` **onSeeked**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-244 "Direct link to Inherited from") `UploaderProps.onSeeked` *** ### onSeekedCapture?[​](#onseekedcapture "Direct link to onSeekedCapture?") > `optional` **onSeekedCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-245 "Direct link to Inherited from") `UploaderProps.onSeekedCapture` *** ### onSeeking?[​](#onseeking "Direct link to onSeeking?") > `optional` **onSeeking**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-246 "Direct link to Inherited from") `UploaderProps.onSeeking` *** ### onSeekingCapture?[​](#onseekingcapture "Direct link to onSeekingCapture?") > `optional` **onSeekingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-247 "Direct link to Inherited from") `UploaderProps.onSeekingCapture` *** ### onSelect?[​](#onselect "Direct link to onSelect?") > `optional` **onSelect**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-248 "Direct link to Inherited from") `UploaderProps.onSelect` *** ### onSelectCapture?[​](#onselectcapture "Direct link to onSelectCapture?") > `optional` **onSelectCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-249 "Direct link to Inherited from") `UploaderProps.onSelectCapture` *** ### onStalled?[​](#onstalled "Direct link to onStalled?") > `optional` **onStalled**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-250 "Direct link to Inherited from") `UploaderProps.onStalled` *** ### onStalledCapture?[​](#onstalledcapture "Direct link to onStalledCapture?") > `optional` **onStalledCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-251 "Direct link to Inherited from") `UploaderProps.onStalledCapture` *** ### onSubmit?[​](#onsubmit "Direct link to onSubmit?") > `optional` **onSubmit**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-252 "Direct link to Inherited from") `UploaderProps.onSubmit` *** ### onSubmitCapture?[​](#onsubmitcapture "Direct link to onSubmitCapture?") > `optional` **onSubmitCapture**: `FormEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-253 "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-254 "Direct link to Inherited from") `UploaderProps.onSuccess` *** ### onSuspend?[​](#onsuspend "Direct link to onSuspend?") > `optional` **onSuspend**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-255 "Direct link to Inherited from") `UploaderProps.onSuspend` *** ### onSuspendCapture?[​](#onsuspendcapture "Direct link to onSuspendCapture?") > `optional` **onSuspendCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-256 "Direct link to Inherited from") `UploaderProps.onSuspendCapture` *** ### onTimeUpdate?[​](#ontimeupdate "Direct link to onTimeUpdate?") > `optional` **onTimeUpdate**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-257 "Direct link to Inherited from") `UploaderProps.onTimeUpdate` *** ### onTimeUpdateCapture?[​](#ontimeupdatecapture "Direct link to onTimeUpdateCapture?") > `optional` **onTimeUpdateCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-258 "Direct link to Inherited from") `UploaderProps.onTimeUpdateCapture` *** ### onToggle?[​](#ontoggle "Direct link to onToggle?") > `optional` **onToggle**: `ToggleEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-259 "Direct link to Inherited from") `UploaderProps.onToggle` *** ### onTouchCancel?[​](#ontouchcancel "Direct link to onTouchCancel?") > `optional` **onTouchCancel**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-260 "Direct link to Inherited from") `UploaderProps.onTouchCancel` *** ### onTouchCancelCapture?[​](#ontouchcancelcapture "Direct link to onTouchCancelCapture?") > `optional` **onTouchCancelCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-261 "Direct link to Inherited from") `UploaderProps.onTouchCancelCapture` *** ### onTouchEnd?[​](#ontouchend "Direct link to onTouchEnd?") > `optional` **onTouchEnd**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-262 "Direct link to Inherited from") `UploaderProps.onTouchEnd` *** ### onTouchEndCapture?[​](#ontouchendcapture "Direct link to onTouchEndCapture?") > `optional` **onTouchEndCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-263 "Direct link to Inherited from") `UploaderProps.onTouchEndCapture` *** ### onTouchMove?[​](#ontouchmove "Direct link to onTouchMove?") > `optional` **onTouchMove**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-264 "Direct link to Inherited from") `UploaderProps.onTouchMove` *** ### onTouchMoveCapture?[​](#ontouchmovecapture "Direct link to onTouchMoveCapture?") > `optional` **onTouchMoveCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-265 "Direct link to Inherited from") `UploaderProps.onTouchMoveCapture` *** ### onTouchStart?[​](#ontouchstart "Direct link to onTouchStart?") > `optional` **onTouchStart**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-266 "Direct link to Inherited from") `UploaderProps.onTouchStart` *** ### onTouchStartCapture?[​](#ontouchstartcapture "Direct link to onTouchStartCapture?") > `optional` **onTouchStartCapture**: `TouchEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-267 "Direct link to Inherited from") `UploaderProps.onTouchStartCapture` *** ### onTransitionCancel?[​](#ontransitioncancel "Direct link to onTransitionCancel?") > `optional` **onTransitionCancel**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-268 "Direct link to Inherited from") `UploaderProps.onTransitionCancel` *** ### onTransitionCancelCapture?[​](#ontransitioncancelcapture "Direct link to onTransitionCancelCapture?") > `optional` **onTransitionCancelCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-269 "Direct link to Inherited from") `UploaderProps.onTransitionCancelCapture` *** ### onTransitionEnd?[​](#ontransitionend "Direct link to onTransitionEnd?") > `optional` **onTransitionEnd**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-270 "Direct link to Inherited from") `UploaderProps.onTransitionEnd` *** ### onTransitionEndCapture?[​](#ontransitionendcapture "Direct link to onTransitionEndCapture?") > `optional` **onTransitionEndCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-271 "Direct link to Inherited from") `UploaderProps.onTransitionEndCapture` *** ### onTransitionRun?[​](#ontransitionrun "Direct link to onTransitionRun?") > `optional` **onTransitionRun**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-272 "Direct link to Inherited from") `UploaderProps.onTransitionRun` *** ### onTransitionRunCapture?[​](#ontransitionruncapture "Direct link to onTransitionRunCapture?") > `optional` **onTransitionRunCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-273 "Direct link to Inherited from") `UploaderProps.onTransitionRunCapture` *** ### onTransitionStart?[​](#ontransitionstart "Direct link to onTransitionStart?") > `optional` **onTransitionStart**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-274 "Direct link to Inherited from") `UploaderProps.onTransitionStart` *** ### onTransitionStartCapture?[​](#ontransitionstartcapture "Direct link to onTransitionStartCapture?") > `optional` **onTransitionStartCapture**: `TransitionEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-275 "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-276 "Direct link to Inherited from") `UploaderProps.onUpload` *** ### onVolumeChange?[​](#onvolumechange "Direct link to onVolumeChange?") > `optional` **onVolumeChange**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-277 "Direct link to Inherited from") `UploaderProps.onVolumeChange` *** ### onVolumeChangeCapture?[​](#onvolumechangecapture "Direct link to onVolumeChangeCapture?") > `optional` **onVolumeChangeCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-278 "Direct link to Inherited from") `UploaderProps.onVolumeChangeCapture` *** ### onWaiting?[​](#onwaiting "Direct link to onWaiting?") > `optional` **onWaiting**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-279 "Direct link to Inherited from") `UploaderProps.onWaiting` *** ### onWaitingCapture?[​](#onwaitingcapture "Direct link to onWaitingCapture?") > `optional` **onWaitingCapture**: `ReactEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-280 "Direct link to Inherited from") `UploaderProps.onWaitingCapture` *** ### onWheel?[​](#onwheel "Direct link to onWheel?") > `optional` **onWheel**: `WheelEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-281 "Direct link to Inherited from") `UploaderProps.onWheel` *** ### onWheelCapture?[​](#onwheelcapture "Direct link to onWheelCapture?") > `optional` **onWheelCapture**: `WheelEventHandler`<`HTMLElement`> #### Inherited from[​](#inherited-from-282 "Direct link to Inherited from") `UploaderProps.onWheelCapture` *** ### plaintext?[​](#plaintext "Direct link to plaintext?") > `optional` **plaintext**: `boolean` Render the control as plain text #### Inherited from[​](#inherited-from-283 "Direct link to Inherited from") `UploaderProps.plaintext` *** ### popover?[​](#popover "Direct link to popover?") > `optional` **popover**: `""` | `"auto"` | `"manual"` #### Inherited from[​](#inherited-from-284 "Direct link to Inherited from") `UploaderProps.popover` *** ### popoverTarget?[​](#popovertarget "Direct link to popoverTarget?") > `optional` **popoverTarget**: `string` #### Inherited from[​](#inherited-from-285 "Direct link to Inherited from") `UploaderProps.popoverTarget` *** ### popoverTargetAction?[​](#popovertargetaction "Direct link to popoverTargetAction?") > `optional` **popoverTargetAction**: `"toggle"` | `"show"` | `"hide"` #### Inherited from[​](#inherited-from-286 "Direct link to Inherited from") `UploaderProps.popoverTargetAction` *** ### prefix?[​](#prefix "Direct link to prefix?") > `optional` **prefix**: `string` #### Inherited from[​](#inherited-from-287 "Direct link to Inherited from") `UploaderProps.prefix` *** ### property?[​](#property "Direct link to property?") > `optional` **property**: `string` #### Inherited from[​](#inherited-from-288 "Direct link to Inherited from") `UploaderProps.property` *** ### radioGroup?[​](#radiogroup "Direct link to radioGroup?") > `optional` **radioGroup**: `string` #### Inherited from[​](#inherited-from-289 "Direct link to Inherited from") `UploaderProps.radioGroup` *** ### readOnly?[​](#readonly "Direct link to readOnly?") > `optional` **readOnly**: `boolean` Make the control readonly #### Inherited from[​](#inherited-from-290 "Direct link to Inherited from") `UploaderProps.readOnly` *** ### rel?[​](#rel "Direct link to rel?") > `optional` **rel**: `string` #### Inherited from[​](#inherited-from-291 "Direct link to Inherited from") `UploaderProps.rel` *** ### removable?[​](#removable "Direct link to removable?") > `optional` **removable**: `boolean` Removable list file #### Inherited from[​](#inherited-from-292 "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-293 "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-294 "Direct link to Inherited from") `UploaderProps.renderThumbnail` *** ### resource?[​](#resource "Direct link to resource?") > `optional` **resource**: `string` #### Inherited from[​](#inherited-from-295 "Direct link to Inherited from") `UploaderProps.resource` *** ### results?[​](#results "Direct link to results?") > `optional` **results**: `number` #### Inherited from[​](#inherited-from-296 "Direct link to Inherited from") `UploaderProps.results` *** ### rev?[​](#rev "Direct link to rev?") > `optional` **rev**: `string` #### Inherited from[​](#inherited-from-297 "Direct link to Inherited from") `UploaderProps.rev` *** ### ripple?[​](#ripple "Direct link to ripple?") > `optional` **ripple**: `boolean` Ripple after button click #### Inherited from[​](#inherited-from-298 "Direct link to Inherited from") `UploaderProps.ripple` *** ### role?[​](#role "Direct link to role?") > `optional` **role**: `AriaRole` #### Inherited from[​](#inherited-from-299 "Direct link to Inherited from") `UploaderProps.role` *** ### security?[​](#security "Direct link to security?") > `optional` **security**: `string` #### Inherited from[​](#inherited-from-300 "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-301 "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-302 "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-303 "Direct link to Inherited from") `UploaderProps.size` *** ### slot?[​](#slot "Direct link to slot?") > `optional` **slot**: `string` #### Inherited from[​](#inherited-from-304 "Direct link to Inherited from") `UploaderProps.slot` *** ### spellCheck?[​](#spellcheck "Direct link to spellCheck?") > `optional` **spellCheck**: `Booleanish` #### Inherited from[​](#inherited-from-305 "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-306 "Direct link to Inherited from") `UploaderProps.startIcon` *** ### style?[​](#style "Direct link to style?") > `optional` **style**: `CSSProperties` Additional style #### Inherited from[​](#inherited-from-307 "Direct link to Inherited from") `UploaderProps.style` *** ### suppressContentEditableWarning?[​](#suppresscontenteditablewarning "Direct link to suppressContentEditableWarning?") > `optional` **suppressContentEditableWarning**: `boolean` #### Inherited from[​](#inherited-from-308 "Direct link to Inherited from") `UploaderProps.suppressContentEditableWarning` *** ### suppressHydrationWarning?[​](#suppresshydrationwarning "Direct link to suppressHydrationWarning?") > `optional` **suppressHydrationWarning**: `boolean` #### Inherited from[​](#inherited-from-309 "Direct link to Inherited from") `UploaderProps.suppressHydrationWarning` *** ### tabIndex?[​](#tabindex "Direct link to tabIndex?") > `optional` **tabIndex**: `number` #### Inherited from[​](#inherited-from-310 "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-311 "Direct link to Inherited from") `UploaderProps.target` *** ### timeout?[​](#timeout "Direct link to timeout?") > `optional` **timeout**: `number` Set upload timeout #### Inherited from[​](#inherited-from-312 "Direct link to Inherited from") `UploaderProps.timeout` *** ### title?[​](#title "Direct link to title?") > `optional` **title**: `string` #### Inherited from[​](#inherited-from-313 "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-314 "Direct link to Inherited from") `UploaderProps.toggleAs` *** ### translate?[​](#translate "Direct link to translate?") > `optional` **translate**: `"yes"` | `"no"` #### Inherited from[​](#inherited-from-315 "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-316 "Direct link to Inherited from") `UploaderProps.type` *** ### typeof?[​](#typeof "Direct link to typeof?") > `optional` **typeof**: `string` #### Inherited from[​](#inherited-from-317 "Direct link to Inherited from") `UploaderProps.typeof` *** ### unselectable?[​](#unselectable "Direct link to unselectable?") > `optional` **unselectable**: `"off"` | `"on"` #### Inherited from[​](#inherited-from-318 "Direct link to Inherited from") `UploaderProps.unselectable` *** ### vocab?[​](#vocab "Direct link to vocab?") > `optional` **vocab**: `string` #### Inherited from[​](#inherited-from-319 "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-320 "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`) => `object` 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.md) 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") `object` --- # 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.md) An assembled set of rSuite components metadata, ready to be passed as a property to the FormBuilder. This view contains CSS loaders. --- # Variable: models > `const` **models**: [`Model`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/classes/Model.md)<`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.md)<[`RsAutoCompleteProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsAutoCompleteProps.md)> --- # Variable: rsBreadcrumb > `const` **rsBreadcrumb**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsBreadcrumbProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsBreadcrumbProps.md)> --- # Variable: rsButton > `const` **rsButton**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<`ButtonProps`> --- # Variable: rsCalendar > `const` **rsCalendar**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsCalendarProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCalendarProps.md)> --- # Variable: rsCard > `const` **rsCard**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsCardProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsCardProps.md)> --- # Variable: rsCheckbox > `const` **rsCheckbox**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<`CheckboxProps`<`any`>> --- # Variable: rsContainer > `const` **rsContainer**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsContainerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsContainerProps.md) & `RefAttributes`<`any`>> --- # Variable: rsDatePicker > `const` **rsDatePicker**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsDatePickerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDatePickerProps.md)> --- # Variable: rsDivider > `const` **rsDivider**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<`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.md)<[`RsDropdownProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsDropdownProps.md)> --- # Variable: rsErrorMessage > `const` **rsErrorMessage**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsErrorMessageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsErrorMessageProps.md)> 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.md)<[`RsHeaderProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsHeaderProps.md)> --- # Variable: rsImage > `const` **rsImage**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsImageProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsImageProps.md)> --- # Variable: rsInput > `const` **rsInput**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsInputProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsInputProps.md)> --- # Variable: rsLabel > `const` **rsLabel**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsLabelProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLabelProps.md)> --- # Variable: rsLink > `const` **rsLink**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsLinkProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsLinkProps.md)> --- # Variable: rsMenu > `const` **rsMenu**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsMenuProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsMenuProps.md)> --- # Variable: rsMessage > `const` **rsMessage**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<`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.md)<[`RsModalProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalProps.md)> --- # Variable: rsModalLayout > `const` **rsModalLayout**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsModalLayoutProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsModalLayoutProps.md)> --- # Variable: rsNumberFormat > `const` **rsNumberFormat**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsNumberFormatProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsNumberFormatProps.md)> --- # Variable: rsPatternFormat > `const` **rsPatternFormat**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsPatternFormatProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsPatternFormatProps.md)> --- # Variable: rsPlaceholderGraph > `const` **rsPlaceholderGraph**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<`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.md)<`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.md)<`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.md)<`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.md)<`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.md)<[`RsRadioGroupProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsRadioGroupProps.md)> --- # Variable: rsSearch > `const` **rsSearch**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsSearchProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsSearchProps.md)> --- # Variable: rsStaticContent > `const` **rsStaticContent**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsStaticContentProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsStaticContentProps.md)> --- # Variable: rsTab > `const` **rsTab**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsTabProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTabProps.md)> --- # Variable: rsTagPicker > `const` **rsTagPicker**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsTagPickerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTagPickerProps.md)> --- # Variable: rsTextArea > `const` **rsTextArea**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsTextAreaProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTextAreaProps.md)> --- # Variable: rsTimePicker > `const` **rsTimePicker**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<[`RsTimePickerProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTimePickerProps.md)> --- # Variable: rsToggle > `const` **rsToggle**: [`Definer`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/interfaces/Definer.md)<`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.md)<[`RsTooltipProps`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/components-rsuite/interfaces/RsTooltipProps.md)> 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.md)<`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.md), [`ComponentLibraryDescription`](https://formengine.io/documentation/documentation/api-reference/@react-form-builder/core/type-aliases/ComponentLibraryDescription.md)> --- # 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 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