@wix/design-system
Version:
@wix/design-system
77 lines (74 loc) • 3.04 kB
Markdown
### dataHook
- type: string
- description: Applies a data-hook HTML attribute that can be used in the tests.
### className
- type: string
- description: Specifies a CSS class name to be appended to the component’s root element.
- internal
### clearButton
- type: boolean
- description: Displays a clear button (X) on a non-empty input.
- default: true
### clearButtonAriaLabel
- type: string
- description: Aria label for the clear button
### initialValue
- type: string
- description: Sets the initial input value.
### value
- type: string
- description: Sets a value to display (controlled mode).
### disabled
- type: boolean
- description: Specifies whether input is disabled.
### onSelect
- type: (option: DropdownLayoutValueOption) => void
- description: Defines a callback function which is called whenever a user selects a different option in the list.
### onManuallyInput
- type: ManualInputFnSignature
- description: Defines a callback function which is called when user performs a submit action.
Submit-Action triggers are: "Enter", "Tab".
### onChange
- type: ChangeEventHandler
- description: Defines a callback function which is called every time input value is changed.
### onFocus
- type: (e?: FocusEvent<HTMLInputElement, Element> | undefined) => void
- description: Defines a standard input onFocus callback.
### onBlur
- type: FocusEventHandler
- description: Defines a standard input onBlur callback.
### autoSelect
- type: boolean
- description: Specifies whether input is auto selected on focus.
### onClear
- type: () => void
- description: Defines a handler for getting notified upon a clear event. When passed, it displays a clear button in the input.
### options
- type: DropdownLayoutOption[]
- description: Specify an array of options to render. When the option is an {optionProps}, the <AddressInput.Option/> component will be rendered on behalf of the user.
### status
- type: "loading" | "error" | "warning"
- description: Specify the status of a field. Mostly used for “loading” indication upon async request calls.
### statusMessage
- type: ReactNode
- description: Defines the message to display on status icon hover. If not given or empty there will be no tooltip.
### border
- type: "none" | "standard" | "round" | "bottomLine"
- description: Control the border style of an input.
### size
- type: "small" | "medium" | "large"
- description: Controls the size of the input. Default value: `medium`.
### placeholder
- type: string
- description: Sets a placeholder message to display.
### noResultsText
- type: ReactNode
- description: Sets the message to show in a dropdown when no results are found.
### popoverProps
- type: PopoverCommonProps
- description: Allows to pass common popover props.
### ref
- type: null | string | (instance: AddressInputRef | null) => void | RefObject<AddressInputRef>
- description: 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).