diff --git a/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html b/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html index 65829c06c1..3e081148c7 100644 --- a/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html +++ b/master/extensions/api/classes/Renderer.K8sApi.NamespaceStore/index.html @@ -2456,8 +2456,7 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
fn
▸ <T>(...args): void
Copyright (c) OpenLens Authors. All rights reserved. -Licensed under MIT License. See LICENSE in root directory for more information.
+A function that does nothing
void
• Optional icon: string
Menu icon
• onClick: () => void | Promise<void>
▸ (): void | Promise<void>
OnClick handler
+void | Promise<void>
• title: string
Menu title
-▸ onClick(): void | Promise<void>
OnClick handler
-void | Promise<void>
This is required because this item can be either rendered as a context menu or as a toolbar in the kube object details page.
• title: string
The title text for the menu item or the hover text for the icon.
-▸ onClick(obj): void
• onClick: (obj: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => void
▸ (obj): void
The action when clicked
-void
• title: string
The title text for the menu item or the hover text for the icon.
diff --git a/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html b/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html index e7d04659c0..1ba06b197b 100644 --- a/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html +++ b/master/extensions/api/interfaces/Common.Types.KubeObjectOnContextMenuOpenContext/index.html @@ -724,13 +724,6 @@ Properties -• menuItems: KubeObjectContextMenuItem[]
▸ navigate(location): void
• navigate: (location: string) => void
▸ (location): void
void
• kind: string
▸ resolve(object): KubeObjectStatus
• resolve: (object: KubeObject<KubeObjectMetadata<KubeObjectScope>, unknown, unknown>) => KubeObjectStatus
▸ (object): KubeObjectStatus
• Optional click: (menuItem: TrayMenuRegistration) => void
▸ (menuItem): void
| Name | +Type | +
|---|---|
menuItem |
+TrayMenuRegistration |
+
void
• Optional enabled: boolean | IComputedValue<boolean>
• Optional visible: IComputedValue<boolean>
▸ Optional click(menuItem): void
| Name | -Type | -
|---|---|
menuItem |
-TrayMenuRegistration |
-
void
CategoryColumnRegistration.priority
• titleProps: TitleCellProps
This function will be used to generate the columns title cell.
-CategoryColumnRegistration.titleProps
-▸ renderCell(entity): ReactNode
• renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => ReactNode
▸ (entity): ReactNode
This function will be called to generate the cells (on demand) for the column
-ReactNode
CategoryColumnRegistration.renderCell
▸ Optional searchFilter(entity): string | string[]
• Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]
▸ (entity): string | string[]
If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.
-string | string[]
CategoryColumnRegistration.searchFilter
▸ Optional sortCallback(entity): string | number | (string | number)[]
• Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]
▸ (entity): string | number | (string | number)[]
If provided then the column will support sorting and this function will be called to determine a row's ordering.
strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.
-string | number | (string | number)[]
CategoryColumnRegistration.sortCallback
+• titleProps: TitleCellProps
This function will be used to generate the columns title cell.
+The sorting order value.
default 50
• titleProps: TitleCellProps
This function will be used to generate the columns title cell.
-▸ renderCell(entity): ReactNode
• renderCell: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => ReactNode
▸ (entity): ReactNode
This function will be called to generate the cells (on demand) for the column
-ReactNode
▸ Optional searchFilter(entity): string | string[]
• Optional searchFilter: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | string[]
▸ (entity): string | string[]
If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.
-string | string[]
▸ Optional sortCallback(entity): string | number | (string | number)[]
• Optional sortCallback: (entity: CatalogEntity<CatalogEntityMetadata, CatalogEntityStatus, CatalogEntitySpec>) => string | number | (string | number)[]
▸ (entity): string | number | (string | number)[]
If provided then the column will support sorting and this function will be called to determine a row's ordering.
strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.
-string | number | (string | number)[]
• titleProps: TitleCellProps
This function will be used to generate the columns title cell.
diff --git a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html index 628a40a8ac..a9433ded46 100644 --- a/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.ConfirmDialogParams/index.html @@ -731,13 +731,6 @@ Properties -• Optional cancel: () => any
▸ (): any
any
• Optional cancelButtonProps: Partial<ButtonProps>
ConfirmDialogBooleanParams.message
• Optional ok: () => any
▸ (): any
any
• Optional okButtonProps: Partial<ButtonProps>
ConfirmDialogBooleanParams.okButtonProps
-▸ Optional cancel(): any
any
▸ Optional ok(): any
any
Partial.className
• Optional close: () => void
▸ (): void
void
Partial.close
+• Optional data-testid: string
Partial.data-testid
• Optional isOpen: boolean
Partial.isOpen
• Optional modal: boolean
Partial.modal
• Optional pinned: boolean
Partial.pinned
-▸ Optional close(): void
• Optional onClose: () => void
▸ (): void
void
Partial.close
-▸ Optional onClose(): void
void
Partial.onClose
▸ Optional onOpen(): void
• Optional onOpen: () => void
▸ (): void
void
Partial.onOpen
▸ Optional open(): void
• Optional open: () => void
▸ (): void
void
Partial.open
+• Optional pinned: boolean
Partial.pinned
diff --git a/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html b/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html index 919569303c..16f2c1f48b 100644 --- a/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.CustomPlaceholderProps/index.html @@ -731,13 +731,6 @@ Properties -PlaceholderProps.className
• clearValue: () => void
▸ (): void
void
PlaceholderProps.clearValue
+• cx: CX
PlaceholderProps.cx
Get the styles of a particular part of the select. Pass in the name of the
property as the first argument, and the current props as the second argument.
See the styles object for the properties available.
PlaceholderProps.getStyles
• getValue: () => Options<NamespaceSelectFilterOption>
▸ (): Options<NamespaceSelectFilterOption>
Options<NamespaceSelectFilterOption>
PlaceholderProps.getValue
+• hasValue: boolean
PlaceholderProps.hasValue
• innerProps: DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>
props passed to the wrapping element for the group.
-PlaceholderProps.innerProps
• isDisabled: boolean
PlaceholderProps.isDisabled
• isFocused: boolean
PlaceholderProps.isFocused
• isMulti: boolean
PlaceholderProps.isMulti
• isRtl: boolean
PlaceholderProps.isRtl
• options: OptionsOrGroups<NamespaceSelectFilterOption, GroupBase<NamespaceSelectFilterOption>>
PlaceholderProps.options
• selectProps: Props<NamespaceSelectFilterOption, true, GroupBase<NamespaceSelectFilterOption>>
PlaceholderProps.selectProps
-• theme: Theme
PlaceholderProps.theme
-▸ clearValue(): void
void
PlaceholderProps.clearValue
-▸ getValue(): Options<Option>
Options<Option>
PlaceholderProps.getValue
-▸ selectOption(newValue): void
• selectOption: (newValue: NamespaceSelectFilterOption) => void
▸ (newValue): void
newValue |
-Option |
+NamespaceSelectFilterOption |
void
PlaceholderProps.selectOption
• selectProps: Props<NamespaceSelectFilterOption, true, GroupBase<NamespaceSelectFilterOption>>
PlaceholderProps.selectProps
+▸ setValue(newValue, action, option?): void
• setValue: (newValue: MultiValue<NamespaceSelectFilterOption>, action: SetValueAction, option?: NamespaceSelectFilterOption) => void
▸ (newValue, action, option?): void
newValue |
-OnChangeValue<Option, IsMulti> |
+MultiValue<NamespaceSelectFilterOption> |
action |
@@ -1063,14 +1043,19 @@ See the ||
option? |
-Option |
+NamespaceSelectFilterOption |
void
PlaceholderProps.setValue
+• theme: Theme
PlaceholderProps.theme
diff --git a/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html b/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html index e2722bc5a5..de4bff3719 100644 --- a/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.DialogProps/index.html @@ -724,13 +724,6 @@ Properties -• Optional className: string
• Optional close: () => void
▸ (): void
void
• Optional data-testid: string
• Optional modal: boolean
• Optional pinned: boolean
▸ Optional close(): void
void
▸ Optional onClose(): void
• Optional onClose: () => void
▸ (): void
void
▸ Optional onOpen(): void
• Optional onOpen: () => void
▸ (): void
void
▸ Optional open(): void
• Optional open: () => void
▸ (): void
void
• Optional pinned: boolean
• Optional animation: string
• Optional contentClass: string | object
• Optional onClose: () => void
▸ (): void
void
• open: boolean
• Optional usePortal: boolean
▸ Optional onClose(): void
void
• Optional addRemoveButtons: Partial<AddRemoveButtonsProps>
Omit.customizeHeader
• Optional customizeRemoveDialog: (selectedItems: K[]) => Partial<ConfirmDialogParams>
▸ (selectedItems): Partial<ConfirmDialogParams>
| Name | +Type | +
|---|---|
selectedItems |
+K[] |
+
Partial<ConfirmDialogParams>
Omit.customizeRemoveDialog
+• Optional customizeTableRowProps: (item: K) => Partial<TableRowProps<K>>
▸ (item): Partial<TableRowProps<K>>
| Name | +Type | +
|---|---|
item |
+K |
+
Partial<TableRowProps<K>>
Omit.customizeTableRowProps
+• Optional dependentStores: SubscribableStore[]
• Optional detailsItem: K
Omit.detailsItem
• Optional failedToLoadMessage: ReactNode
Message to display when a store failed to load
default "Failed to load items"
Omit.failedToLoadMessage
• Optional filterCallbacks: ItemsFilters<K>
Omit.filterCallbacks
• Optional filterItems: ItemsFilter<K>[]
deprecated
Omit.filterItems
• Optional getItems: () => K[]
▸ (): K[]
K[]
• Optional hasDetailsView: boolean
Omit.hasDetailsView
• Optional headerClassName: IClassName
Omit.headerClassName
• Optional hideFilters: boolean
Omit.hideFilters
• Optional isConfigurable: boolean
Omit.isConfigurable
• Optional isReady: boolean
Omit.isReady
• Optional isSelectable: boolean
Omit.isSelectable
• Optional items: K[]
• Optional onDetails: (item: K) => void
▸ (item): void
| Name | +Type | +
|---|---|
item |
+K |
+
void
Omit.onDetails
+• Optional renderFooter: (parent: NonInjectedItemListLayout<K, false>) => ReactNode
▸ (parent): ReactNode
| Name | +Type | +
|---|---|
parent |
+NonInjectedItemListLayout<K, false> |
+
ReactNode
Omit.renderFooter
+• Optional renderHeaderTitle: RenderHeaderTitle<K, false>
Omit.renderHeaderTitle
• Optional renderItemMenu: (item: K, store: ItemListStore<K, false>) => ReactNode
▸ (item, store): ReactNode
| Name | +Type | +
|---|---|
item |
+K |
+
store |
+ItemListStore<K, false> |
+
ReactNode
Omit.renderItemMenu
+• renderTableContents: (item: K) => (ReactNode | TableCellProps)[]
▸ (item): (ReactNode | TableCellProps)[]
| Name | +Type | +
|---|---|
item |
+K |
+
(ReactNode | TableCellProps)[]
Omit.renderTableContents
+• Optional renderTableHeader: (undefined | null | TableCellProps)[]
Omit.renderTableHeader
• Optional searchFilters: SearchFilter<K>[]
Omit.searchFilters
• Optional showHeader: boolean
Omit.showHeader
• Optional sortingCallbacks: TableSortCallbacks<K>
Omit.sortingCallbacks
• Optional tableId: string
Omit.tableId
• Optional tableProps: Partial<TableProps<K>>
Omit.tableProps
• Optional virtual: boolean
Omit.virtual
-▸ Optional customizeRemoveDialog(selectedItems): Partial<ConfirmDialogParams>
| Name | -Type | -
|---|---|
selectedItems |
-Item[] |
-
Partial<ConfirmDialogParams>
Omit.customizeRemoveDialog
-▸ Optional customizeTableRowProps(item): Partial<TableRowProps<Item>>
| Name | -Type | -
|---|---|
item |
-Item |
-
Partial<TableRowProps<Item>>
Omit.customizeTableRowProps
-▸ Optional getItems(): K[]
K[]
▸ Optional onDetails(item): void
| Name | -Type | -
|---|---|
item |
-Item |
-
void
Omit.onDetails
-▸ Optional renderFooter(parent): ReactNode
| Name | -Type | -
|---|---|
parent |
-NonInjectedItemListLayout<Item, PreLoadStores> |
-
ReactNode
Omit.renderFooter
-▸ Optional renderItemMenu(item, store): ReactNode
| Name | -Type | -
|---|---|
item |
-Item |
-
store |
-ItemListStore<Item, PreLoadStores> |
-
ReactNode
Omit.renderItemMenu
-▸ renderTableContents(item): (ReactNode | TableCellProps)[]
| Name | -Type | -
|---|---|
item |
-Item |
-
(ReactNode | TableCellProps)[]
Omit.renderTableContents
+Omit.virtual
diff --git a/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html b/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html index 0d526782b9..bfad678bf0 100644 --- a/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.KubeObjectMenuProps/index.html @@ -849,6 +849,13 @@ object + + +• object: TKubeObject
• Optional onOpen: () => void
▸ (): void
void
• Optional position: MenuPosition
• Optional removable: boolean
• Optional removeAction: () => void | Promise<void>
▸ (): void | Promise<void>
deprecated Provide your own remove <MenuItem> as part of the children passed to this component
void | Promise<void>
• Optional removeConfirmationMessage: ReactNode | () => ReactNode
deprecated Provide your own remove <MenuItem> as part of the children passed to this component
MenuActionsProps.removeConfirmationMessage
• Optional toggleEvent: "contextmenu" | "click"
• Optional toolbar: boolean
• Optional triggerIcon: ReactNode | IconProps & TooltipDecoratorProps
• Optional updateAction: () => void | Promise<void>
▸ (): void | Promise<void>
deprecated Provide your own update <MenuItem> as part of the children passed to this component
void | Promise<void>
• Optional usePortal: boolean | HTMLElement
▸ Optional close(): void
void
▸ Optional onOpen(): void
void
▸ Optional open(): void
void
▸ Optional removeAction(): void | Promise<void>
deprecated Provide your own remove <MenuItem> as part of the children passed to this component
void | Promise<void>
▸ Optional updateAction(): void | Promise<void>
deprecated Provide your own update <MenuItem> as part of the children passed to this component
void | Promise<void>
void
Partial.isOpen
• Optional onOpen: () => void
▸ (): void
void
• Optional position: MenuPosition
Partial.position
• Optional removeAction: () => void | Promise<void>
▸ (): void | Promise<void>
deprecated Provide your own remove <MenuItem> as part of the children passed to this component
void | Promise<void>
• Optional removeConfirmationMessage: ReactNode | () => ReactNode
deprecated Provide your own remove <MenuItem> as part of the children passed to this component
• Optional triggerIcon: ReactNode | IconProps & TooltipDecoratorProps
• Optional updateAction: () => void | Promise<void>
▸ (): void | Promise<void>
deprecated Provide your own update <MenuItem> as part of the children passed to this component
void | Promise<void>
• Optional usePortal: boolean | HTMLElement
▸ Optional close(): void
void
Partial.close
▸ Optional onOpen(): void
void
▸ Optional open(): void
void
Partial.open
-▸ Optional removeAction(): void | Promise<void>
deprecated Provide your own remove <MenuItem> as part of the children passed to this component
void | Promise<void>
▸ Optional updateAction(): void | Promise<void>
deprecated Provide your own update <MenuItem> as part of the children passed to this component
void | Promise<void>
• Optional aria-errormessage: string
Omit.onBlur
• Optional onFocus: FocusEventHandler<HTMLInputElement>
Handle focus events on the control
-Omit.onFocus
-• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>
Handle key down events on the select
-Omit.onKeyDown
-• Optional onMenuScrollToBottom: (event: TouchEvent | WheelEvent) => void
• Optional onChange: (newValue: OnChangeValue<{ label: string ; value: string }, IsMulti>, actionMeta: ActionMeta<{ label: string ; value: string }>) => void
▸ (event): void
Fired when the user scrolls to the bottom of the menu
+▸ (newValue, actionMeta): void
Handle change events on the select
event |
-TouchEvent | WheelEvent |
+newValue |
+OnChangeValue<{ label: string ; value: string }, IsMulti> |
+
actionMeta |
+ActionMeta<{ label: string ; value: string }> |
void
Omit.onMenuScrollToBottom
-• Optional onMenuScrollToTop: (event: TouchEvent | WheelEvent) => void
▸ (event): void
Fired when the user scrolls to the top of the menu
-| Name | -Type | -
|---|---|
event |
-TouchEvent | WheelEvent |
-
void
Omit.onMenuScrollToTop
-• Optional openMenuOnClick: boolean
Allows control of whether the menu is opened when the Select is clicked
-Omit.openMenuOnClick
-• Optional openMenuOnFocus: boolean
Allows control of whether the menu is opened when the Select is focused
-Omit.openMenuOnFocus
-• Optional pageSize: number
Number of options to jump in menu when page{up|down} keys are used
-Omit.pageSize
-• Optional placeholder: ReactNode
Placeholder for the select value
-Omit.placeholder
-• Optional screenReaderStatus: (obj: { count: number }) => string
▸ (obj): string
Status to relay to screen readers
-| Name | -Type | -
|---|---|
obj |
-Object |
-
obj.count |
-number |
-
string
Omit.screenReaderStatus
-• Optional showIcons: boolean
• Optional sort: NamespaceSelectSort
• Optional styles: StylesConfig<{ label: string ; value: string }, IsMulti, GroupBase<{ label: string ; value: string }>>
Style modifier methods
-A basic example can be found at the bottom of the Replacing builtins documentation.
-Omit.styles
-• Optional tabIndex: number
Sets the tabIndex attribute on the input
-Omit.tabIndex
-• Optional tabSelectsValue: boolean
Select the currently focused option when the user presses tab
-Omit.tabSelectsValue
-• Optional theme: ThemeConfig
Theme modifier method
-Omit.theme
-• Optional themeName: "lens" | "dark" | "light" | "outlined"
Omit.themeName
-• value: undefined | null | string
▸ Optional onChange(newValue, actionMeta): void
Handle change events on the select
-| Name | -Type | -
|---|---|
newValue |
-OnChangeValue<Option, IsMulti> |
-
actionMeta |
-ActionMeta<Option> |
-
void
Omit.onChange
• Optional onFocus: FocusEventHandler<HTMLInputElement>
Handle focus events on the control
+Omit.onFocus
+▸ Optional onInputChange(newValue, actionMeta): void
• Optional onInputChange: (newValue: string, actionMeta: InputActionMeta) => void
▸ (newValue, actionMeta): void
Handle change events on the input
-void
Omit.onInputChange
• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>
Handle key down events on the select
+Omit.onKeyDown
+▸ Optional onMenuClose(): void
• Optional onMenuClose: () => void
▸ (): void
Handle the menu closing
-void
Omit.onMenuClose
▸ Optional onMenuOpen(): void
• Optional onMenuOpen: () => void
▸ (): void
Handle the menu opening
-void
Omit.onMenuOpen
+• Optional onMenuScrollToBottom: (event: TouchEvent | WheelEvent) => void
▸ (event): void
Fired when the user scrolls to the bottom of the menu
+| Name | +Type | +
|---|---|
event |
+TouchEvent | WheelEvent |
+
void
Omit.onMenuScrollToBottom
+• Optional onMenuScrollToTop: (event: TouchEvent | WheelEvent) => void
▸ (event): void
Fired when the user scrolls to the top of the menu
+| Name | +Type | +
|---|---|
event |
+TouchEvent | WheelEvent |
+
void
Omit.onMenuScrollToTop
+• Optional openMenuOnClick: boolean
Allows control of whether the menu is opened when the Select is clicked
+Omit.openMenuOnClick
+• Optional openMenuOnFocus: boolean
Allows control of whether the menu is opened when the Select is focused
+Omit.openMenuOnFocus
+• Optional pageSize: number
Number of options to jump in menu when page{up|down} keys are used
+Omit.pageSize
+• Optional placeholder: ReactNode
Placeholder for the select value
+Omit.placeholder
+• Optional screenReaderStatus: (obj: { count: number }) => string
▸ (obj): string
Status to relay to screen readers
+| Name | +Type | +
|---|---|
obj |
+Object |
+
obj.count |
+number |
+
string
Omit.screenReaderStatus
+• Optional showIcons: boolean
• Optional sort: NamespaceSelectSort
• Optional styles: StylesConfig<{ label: string ; value: string }, IsMulti, GroupBase<{ label: string ; value: string }>>
Style modifier methods
+A basic example can be found at the bottom of the Replacing builtins documentation.
+Omit.styles
+• Optional tabIndex: number
Sets the tabIndex attribute on the input
+Omit.tabIndex
+• Optional tabSelectsValue: boolean
Select the currently focused option when the user presses tab
+Omit.tabSelectsValue
+• Optional theme: ThemeConfig
Theme modifier method
+Omit.theme
+• Optional themeName: "lens" | "dark" | "light" | "outlined"
Omit.themeName
+• value: undefined | null | string
• Optional disabled: boolean
• Optional value: T
▸ onChange(value): void
• onChange: (value: T) => void
▸ (value): void
void
• Optional value: T
• Optional aria-errormessage: string
Omit.onBlur
• Optional onFocus: FocusEventHandler<HTMLInputElement>
Handle focus events on the control
-Omit.onFocus
-• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>
Handle key down events on the select
-Omit.onKeyDown
-• Optional onMenuScrollToBottom: (event: TouchEvent | WheelEvent) => void
▸ (event): void
Fired when the user scrolls to the bottom of the menu
-| Name | -Type | -
|---|---|
event |
-TouchEvent | WheelEvent |
-
void
Omit.onMenuScrollToBottom
-• Optional onMenuScrollToTop: (event: TouchEvent | WheelEvent) => void
▸ (event): void
Fired when the user scrolls to the top of the menu
-| Name | -Type | -
|---|---|
event |
-TouchEvent | WheelEvent |
-
void
Omit.onMenuScrollToTop
-• Optional openMenuOnClick: boolean
Allows control of whether the menu is opened when the Select is clicked
-Omit.openMenuOnClick
-• Optional openMenuOnFocus: boolean
Allows control of whether the menu is opened when the Select is focused
-Omit.openMenuOnFocus
-• options: OptionsOrGroups<Option, Group> | LegacyAutoConvertedOptions
• Optional pageSize: number
Number of options to jump in menu when page{up|down} keys are used
-Omit.pageSize
-• Optional placeholder: ReactNode
Placeholder for the select value
-Omit.placeholder
-• Optional screenReaderStatus: (obj: { count: number }) => string
▸ (obj): string
Status to relay to screen readers
-| Name | -Type | -
|---|---|
obj |
-Object |
-
obj.count |
-number |
-
string
Omit.screenReaderStatus
-• Optional styles: StylesConfig<Option, IsMulti, Group>
Style modifier methods
-A basic example can be found at the bottom of the Replacing builtins documentation.
-Omit.styles
-• Optional tabIndex: number
Sets the tabIndex attribute on the input
-Omit.tabIndex
-• Optional tabSelectsValue: boolean
Select the currently focused option when the user presses tab
-Omit.tabSelectsValue
-• Optional theme: ThemeConfig
Theme modifier method
-Omit.theme
-• Optional themeName: "lens" | "dark" | "light" | "outlined"
• Optional value: PropsValue<Value>
▸ Optional onChange(newValue, actionMeta): void
• Optional onChange: (newValue: OnChangeValue<Option, IsMulti>, actionMeta: ActionMeta<Option>) => void
▸ (newValue, actionMeta): void
Handle change events on the select
-void
Omit.onChange
• Optional onFocus: FocusEventHandler<HTMLInputElement>
Handle focus events on the control
+Omit.onFocus
+▸ Optional onInputChange(newValue, actionMeta): void
• Optional onInputChange: (newValue: string, actionMeta: InputActionMeta) => void
▸ (newValue, actionMeta): void
Handle change events on the input
-void
Omit.onInputChange
• Optional onKeyDown: KeyboardEventHandler<HTMLDivElement>
Handle key down events on the select
+Omit.onKeyDown
+▸ Optional onMenuClose(): void
• Optional onMenuClose: () => void
▸ (): void
Handle the menu closing
-void
Omit.onMenuClose
▸ Optional onMenuOpen(): void
• Optional onMenuOpen: () => void
▸ (): void
Handle the menu opening
-void
Omit.onMenuOpen
+• Optional onMenuScrollToBottom: (event: TouchEvent | WheelEvent) => void
▸ (event): void
Fired when the user scrolls to the bottom of the menu
+| Name | +Type | +
|---|---|
event |
+TouchEvent | WheelEvent |
+
void
Omit.onMenuScrollToBottom
+• Optional onMenuScrollToTop: (event: TouchEvent | WheelEvent) => void
▸ (event): void
Fired when the user scrolls to the top of the menu
+| Name | +Type | +
|---|---|
event |
+TouchEvent | WheelEvent |
+
void
Omit.onMenuScrollToTop
+• Optional openMenuOnClick: boolean
Allows control of whether the menu is opened when the Select is clicked
+Omit.openMenuOnClick
+• Optional openMenuOnFocus: boolean
Allows control of whether the menu is opened when the Select is focused
+Omit.openMenuOnFocus
+• options: OptionsOrGroups<Option, Group> | LegacyAutoConvertedOptions
• Optional pageSize: number
Number of options to jump in menu when page{up|down} keys are used
+Omit.pageSize
+• Optional placeholder: ReactNode
Placeholder for the select value
+Omit.placeholder
+• Optional screenReaderStatus: (obj: { count: number }) => string
▸ (obj): string
Status to relay to screen readers
+| Name | +Type | +
|---|---|
obj |
+Object |
+
obj.count |
+number |
+
string
Omit.screenReaderStatus
+• Optional styles: StylesConfig<Option, IsMulti, Group>
Style modifier methods
+A basic example can be found at the bottom of the Replacing builtins documentation.
+Omit.styles
+• Optional tabIndex: number
Sets the tabIndex attribute on the input
+Omit.tabIndex
+• Optional tabSelectsValue: boolean
Select the currently focused option when the user presses tab
+Omit.tabSelectsValue
+• Optional theme: ThemeConfig
Theme modifier method
+Omit.theme
+• Optional themeName: "lens" | "dark" | "light" | "outlined"
• Optional value: PropsValue<Value>
• Optional back: (evt: MouseEvent<Element, MouseEvent> | KeyboardEvent) => void
▸ (evt): void
| Name | +Type | +
|---|---|
evt |
+MouseEvent<Element, MouseEvent> | KeyboardEvent |
+
void
• Optional children: ReactNode
• Optional closeButtonProps: Object
| Name | -Type | -
|---|---|
evt |
-MouseEvent<Element, MouseEvent> | KeyboardEvent |
-
void
Omit.draggable
• Optional getAriaLabel: (index: number) => string
▸ (index): string
| Name | +Type | +
|---|---|
index |
+number |
+
string
Omit.getAriaLabel
+• Optional getAriaValueText: (value: number, index: number) => string
▸ (value, index): string
| Name | +Type | +
|---|---|
value |
+number |
+
index |
+number |
+
string
Omit.getAriaValueText
+• Optional hidden: boolean
Omit.hidden
• Optional id: string
Omit.id
• Optional inlist: any
Omit.inlist
• Optional innerRef: Ref<any>
Omit.innerRef
• Optional inputMode: "search" | "url" | "email" | "none" | "text" | "tel" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
Omit.inputMode
• Optional is: string
Specify that a standard HTML element should behave like a defined custom built-in element
see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is
Omit.is
• Optional itemID: string
Omit.itemID
• Optional itemProp: string
Omit.itemProp
• Optional itemRef: string
Omit.itemRef
• Optional itemScope: boolean
Omit.itemScope
• Optional itemType: string
Omit.itemType
• Optional key: null | Key
Omit.key
• Optional lang: string
Omit.lang
• Optional marks: boolean | Mark[]
Omit.marks
• Optional max: number
Omit.max
• Optional min: number
Omit.min
• Optional name: string
Omit.name
• Optional onAbort: ReactEventHandler<HTMLSpanElement>
Omit.onAbort
• Optional onAbortCapture: ReactEventHandler<HTMLSpanElement>
Omit.onAbortCapture
• Optional onAnimationEnd: AnimationEventHandler<HTMLSpanElement>
Omit.onAnimationEnd
• Optional onAnimationEndCapture: AnimationEventHandler<HTMLSpanElement>
Omit.onAnimationEndCapture
• Optional onAnimationIteration: AnimationEventHandler<HTMLSpanElement>
Omit.onAnimationIteration
• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLSpanElement>
Omit.onAnimationIterationCapture
• Optional onAnimationStart: AnimationEventHandler<HTMLSpanElement>
Omit.onAnimationStart
• Optional onAnimationStartCapture: AnimationEventHandler<HTMLSpanElement>
Omit.onAnimationStartCapture
• Optional onAuxClick: MouseEventHandler<HTMLSpanElement>
Omit.onAuxClick
• Optional onAuxClickCapture: MouseEventHandler<HTMLSpanElement>
Omit.onAuxClickCapture
• Optional onBeforeInput: FormEventHandler<HTMLSpanElement>
Omit.onBeforeInput
• Optional onBeforeInputCapture: FormEventHandler<HTMLSpanElement>
Omit.onBeforeInputCapture
• Optional onBlur: FocusEventHandler<HTMLSpanElement>
Omit.onBlur
• Optional onBlurCapture: FocusEventHandler<HTMLSpanElement>
Omit.onBlurCapture
• Optional onCanPlay: ReactEventHandler<HTMLSpanElement>
Omit.onCanPlay
• Optional onCanPlayCapture: ReactEventHandler<HTMLSpanElement>
Omit.onCanPlayCapture
• Optional onCanPlayThrough: ReactEventHandler<HTMLSpanElement>
Omit.onCanPlayThrough
• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLSpanElement>
Omit.onCanPlayThroughCapture
• Optional onChangeCapture: FormEventHandler<HTMLSpanElement>
Omit.onChangeCapture
• Optional onClick: MouseEventHandler<HTMLSpanElement>
Omit.onClick
-• Optional onClickCapture: MouseEventHandler<HTMLSpanElement>
Omit.onClickCapture
-• Optional onCompositionEnd: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionEnd
-• Optional onCompositionEndCapture: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionEndCapture
-• Optional onCompositionStart: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionStart
-• Optional onCompositionStartCapture: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionStartCapture
-• Optional onCompositionUpdate: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionUpdate
-• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionUpdateCapture
-• Optional onContextMenu: MouseEventHandler<HTMLSpanElement>
Omit.onContextMenu
-• Optional onContextMenuCapture: MouseEventHandler<HTMLSpanElement>
Omit.onContextMenuCapture
-• Optional onCopy: ClipboardEventHandler<HTMLSpanElement>
Omit.onCopy
-• Optional onCopyCapture: ClipboardEventHandler<HTMLSpanElement>
Omit.onCopyCapture
-• Optional onCut: ClipboardEventHandler<HTMLSpanElement>
Omit.onCut
-• Optional onCutCapture: ClipboardEventHandler<HTMLSpanElement>
Omit.onCutCapture
-• Optional onDoubleClick: MouseEventHandler<HTMLSpanElement>
Omit.onDoubleClick
-• Optional onDoubleClickCapture: MouseEventHandler<HTMLSpanElement>
Omit.onDoubleClickCapture
-• Optional onDrag: DragEventHandler<HTMLSpanElement>
Omit.onDrag
-• Optional onDragCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragCapture
-• Optional onDragEnd: DragEventHandler<HTMLSpanElement>
Omit.onDragEnd
-• Optional onDragEndCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragEndCapture
-• Optional onDragEnter: DragEventHandler<HTMLSpanElement>
Omit.onDragEnter
-• Optional onDragEnterCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragEnterCapture
-• Optional onDragExit: DragEventHandler<HTMLSpanElement>
Omit.onDragExit
-• Optional onDragExitCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragExitCapture
-• Optional onDragLeave: DragEventHandler<HTMLSpanElement>
Omit.onDragLeave
-• Optional onDragLeaveCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragLeaveCapture
-• Optional onDragOver: DragEventHandler<HTMLSpanElement>
Omit.onDragOver
-• Optional onDragOverCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragOverCapture
-• Optional onDragStart: DragEventHandler<HTMLSpanElement>
Omit.onDragStart
-• Optional onDragStartCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragStartCapture
-• Optional onDrop: DragEventHandler<HTMLSpanElement>
Omit.onDrop
-• Optional onDropCapture: DragEventHandler<HTMLSpanElement>
Omit.onDropCapture
-• Optional onDurationChange: ReactEventHandler<HTMLSpanElement>
Omit.onDurationChange
-• Optional onDurationChangeCapture: ReactEventHandler<HTMLSpanElement>
Omit.onDurationChangeCapture
-• Optional onEmptied: ReactEventHandler<HTMLSpanElement>
Omit.onEmptied
-• Optional onEmptiedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onEmptiedCapture
-• Optional onEncrypted: ReactEventHandler<HTMLSpanElement>
Omit.onEncrypted
-• Optional onEncryptedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onEncryptedCapture
-• Optional onEnded: ReactEventHandler<HTMLSpanElement>
Omit.onEnded
-• Optional onEndedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onEndedCapture
-• Optional onError: ReactEventHandler<HTMLSpanElement>
Omit.onError
-• Optional onErrorCapture: ReactEventHandler<HTMLSpanElement>
Omit.onErrorCapture
-• Optional onFocus: FocusEventHandler<HTMLSpanElement>
Omit.onFocus
-• Optional onFocusCapture: FocusEventHandler<HTMLSpanElement>
Omit.onFocusCapture
-• Optional onGotPointerCapture: PointerEventHandler<HTMLSpanElement>
Omit.onGotPointerCapture
-• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>
Omit.onGotPointerCaptureCapture
-• Optional onInput: FormEventHandler<HTMLSpanElement>
Omit.onInput
-• Optional onInputCapture: FormEventHandler<HTMLSpanElement>
Omit.onInputCapture
-• Optional onInvalid: FormEventHandler<HTMLSpanElement>
Omit.onInvalid
-• Optional onInvalidCapture: FormEventHandler<HTMLSpanElement>
Omit.onInvalidCapture
-• Optional onKeyDown: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyDown
-• Optional onKeyDownCapture: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyDownCapture
-• Optional onKeyPress: KeyboardEventHandler<HTMLSpanElement>
deprecated
Omit.onKeyPress
-• Optional onKeyPressCapture: KeyboardEventHandler<HTMLSpanElement>
deprecated
Omit.onKeyPressCapture
-• Optional onKeyUp: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyUp
-• Optional onKeyUpCapture: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyUpCapture
-• Optional onLoad: ReactEventHandler<HTMLSpanElement>
Omit.onLoad
-• Optional onLoadCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadCapture
-• Optional onLoadStart: ReactEventHandler<HTMLSpanElement>
Omit.onLoadStart
-• Optional onLoadStartCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadStartCapture
-• Optional onLoadedData: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedData
-• Optional onLoadedDataCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedDataCapture
-• Optional onLoadedMetadata: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedMetadata
-• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedMetadataCapture
-• Optional onLostPointerCapture: PointerEventHandler<HTMLSpanElement>
Omit.onLostPointerCapture
-• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>
Omit.onLostPointerCaptureCapture
-• Optional onMouseDown: MouseEventHandler<HTMLSpanElement>
Omit.onMouseDown
-• Optional onMouseDownCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseDownCapture
-• Optional onMouseEnter: MouseEventHandler<HTMLSpanElement>
Omit.onMouseEnter
-• Optional onMouseLeave: MouseEventHandler<HTMLSpanElement>
Omit.onMouseLeave
-• Optional onMouseMove: MouseEventHandler<HTMLSpanElement>
Omit.onMouseMove
-• Optional onMouseMoveCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseMoveCapture
-• Optional onMouseOut: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOut
-• Optional onMouseOutCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOutCapture
-• Optional onMouseOver: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOver
-• Optional onMouseOverCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOverCapture
-• Optional onMouseUp: MouseEventHandler<HTMLSpanElement>
Omit.onMouseUp
-• Optional onMouseUpCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseUpCapture
-• Optional onPaste: ClipboardEventHandler<HTMLSpanElement>
Omit.onPaste
-• Optional onPasteCapture: ClipboardEventHandler<HTMLSpanElement>
Omit.onPasteCapture
-• Optional onPause: ReactEventHandler<HTMLSpanElement>
Omit.onPause
-• Optional onPauseCapture: ReactEventHandler<HTMLSpanElement>
Omit.onPauseCapture
-• Optional onPlay: ReactEventHandler<HTMLSpanElement>
Omit.onPlay
-• Optional onPlayCapture: ReactEventHandler<HTMLSpanElement>
Omit.onPlayCapture
-• Optional onPlaying: ReactEventHandler<HTMLSpanElement>
Omit.onPlaying
-• Optional onPlayingCapture: ReactEventHandler<HTMLSpanElement>
Omit.onPlayingCapture
-• Optional onPointerCancel: PointerEventHandler<HTMLSpanElement>
Omit.onPointerCancel
-• Optional onPointerCancelCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerCancelCapture
-• Optional onPointerDown: PointerEventHandler<HTMLSpanElement>
Omit.onPointerDown
-• Optional onPointerDownCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerDownCapture
-• Optional onPointerEnter: PointerEventHandler<HTMLSpanElement>
Omit.onPointerEnter
-• Optional onPointerEnterCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerEnterCapture
-• Optional onPointerLeave: PointerEventHandler<HTMLSpanElement>
Omit.onPointerLeave
-• Optional onPointerLeaveCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerLeaveCapture
-• Optional onPointerMove: PointerEventHandler<HTMLSpanElement>
Omit.onPointerMove
-• Optional onPointerMoveCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerMoveCapture
-• Optional onPointerOut: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOut
-• Optional onPointerOutCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOutCapture
-• Optional onPointerOver: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOver
-• Optional onPointerOverCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOverCapture
-• Optional onPointerUp: PointerEventHandler<HTMLSpanElement>
Omit.onPointerUp
-• Optional onPointerUpCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerUpCapture
-• Optional onProgress: ReactEventHandler<HTMLSpanElement>
Omit.onProgress
-• Optional onProgressCapture: ReactEventHandler<HTMLSpanElement>
Omit.onProgressCapture
-• Optional onRateChange: ReactEventHandler<HTMLSpanElement>
Omit.onRateChange
-• Optional onRateChangeCapture: ReactEventHandler<HTMLSpanElement>
Omit.onRateChangeCapture
-• Optional onReset: FormEventHandler<HTMLSpanElement>
Omit.onReset
-• Optional onResetCapture: FormEventHandler<HTMLSpanElement>
Omit.onResetCapture
-• Optional onScroll: UIEventHandler<HTMLSpanElement>
Omit.onScroll
-• Optional onScrollCapture: UIEventHandler<HTMLSpanElement>
Omit.onScrollCapture
-• Optional onSeeked: ReactEventHandler<HTMLSpanElement>
Omit.onSeeked
-• Optional onSeekedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSeekedCapture
-• Optional onSeeking: ReactEventHandler<HTMLSpanElement>
Omit.onSeeking
-• Optional onSeekingCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSeekingCapture
-• Optional onSelect: ReactEventHandler<HTMLSpanElement>
Omit.onSelect
-• Optional onSelectCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSelectCapture
-• Optional onStalled: ReactEventHandler<HTMLSpanElement>
Omit.onStalled
-• Optional onStalledCapture: ReactEventHandler<HTMLSpanElement>
Omit.onStalledCapture
-• Optional onSubmit: FormEventHandler<HTMLSpanElement>
Omit.onSubmit
-• Optional onSubmitCapture: FormEventHandler<HTMLSpanElement>
Omit.onSubmitCapture
-• Optional onSuspend: ReactEventHandler<HTMLSpanElement>
Omit.onSuspend
-• Optional onSuspendCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSuspendCapture
-• Optional onTimeUpdate: ReactEventHandler<HTMLSpanElement>
Omit.onTimeUpdate
-• Optional onTimeUpdateCapture: ReactEventHandler<HTMLSpanElement>
Omit.onTimeUpdateCapture
-• Optional onTouchCancel: TouchEventHandler<HTMLSpanElement>
Omit.onTouchCancel
-• Optional onTouchCancelCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchCancelCapture
-• Optional onTouchEnd: TouchEventHandler<HTMLSpanElement>
Omit.onTouchEnd
-• Optional onTouchEndCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchEndCapture
-• Optional onTouchMove: TouchEventHandler<HTMLSpanElement>
Omit.onTouchMove
-• Optional onTouchMoveCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchMoveCapture
-• Optional onTouchStart: TouchEventHandler<HTMLSpanElement>
Omit.onTouchStart
-• Optional onTouchStartCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchStartCapture
-• Optional onTransitionEnd: TransitionEventHandler<HTMLSpanElement>
Omit.onTransitionEnd
-• Optional onTransitionEndCapture: TransitionEventHandler<HTMLSpanElement>
Omit.onTransitionEndCapture
-• Optional onVolumeChange: ReactEventHandler<HTMLSpanElement>
Omit.onVolumeChange
-• Optional onVolumeChangeCapture: ReactEventHandler<HTMLSpanElement>
Omit.onVolumeChangeCapture
-• Optional onWaiting: ReactEventHandler<HTMLSpanElement>
Omit.onWaiting
-• Optional onWaitingCapture: ReactEventHandler<HTMLSpanElement>
Omit.onWaitingCapture
-• Optional onWheel: WheelEventHandler<HTMLSpanElement>
Omit.onWheel
-• Optional onWheelCapture: WheelEventHandler<HTMLSpanElement>
Omit.onWheelCapture
-• Optional orientation: "horizontal" | "vertical"
Omit.orientation
-• Optional placeholder: string
Omit.placeholder
-• Optional prefix: string
Omit.prefix
-• Optional property: string
Omit.property
-• Optional radioGroup: string
Omit.radioGroup
-• Optional ref: null | (instance: null | HTMLSpanElement) => void | RefObject<HTMLSpanElement>
Omit.ref
-• Optional resource: string
Omit.resource
-• Optional results: number
Omit.results
-• Optional role: AriaRole
Omit.role
-• Optional security: string
Omit.security
-• Optional slot: string
Omit.slot
-• Optional spellCheck: Booleanish
Omit.spellCheck
-• Optional step: null | number
Omit.step
-• Optional style: CSSProperties
Omit.style
-• Optional suppressContentEditableWarning: boolean
Omit.suppressContentEditableWarning
-• Optional suppressHydrationWarning: boolean
Omit.suppressHydrationWarning
-• Optional tabIndex: number
Omit.tabIndex
-• Optional title: string
Omit.title
-• Optional track: false | "normal" | "inverted"
Omit.track
-• Optional translate: "yes" | "no"
Omit.translate
-• Optional typeof: string
Omit.typeof
-• Optional unselectable: "on" | "off"
Omit.unselectable
-• Optional value: number | number[]
Omit.value
-• Optional valueLabelDisplay: "on" | "off" | "auto"
Omit.valueLabelDisplay
-• Optional valueLabelFormat: string | (value: number, index: number) => ReactNode
Omit.valueLabelFormat
-• Optional vocab: string
Omit.vocab
-▸ Optional getAriaLabel(index): string
| Name | -Type | -
|---|---|
index |
-number |
-
string
Omit.getAriaLabel
-▸ Optional getAriaValueText(value, index): string
| Name | -Type | -
|---|---|
value |
-number |
-
index |
-number |
-
string
Omit.getAriaValueText
-▸ onChange(evt, value): void
| Name | -Type | -
|---|---|
evt |
-FormEvent<any> |
-
value |
-number |
-
void
▸ Optional onChangeCommitted(event, value): void
• Optional onChangeCommitted: (event: ChangeEvent<{}>, value: number | number[]) => void
▸ (event, value): void
void
Omit.onChangeCommitted
• Optional onClick: MouseEventHandler<HTMLSpanElement>
Omit.onClick
+• Optional onClickCapture: MouseEventHandler<HTMLSpanElement>
Omit.onClickCapture
+• Optional onCompositionEnd: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionEnd
+• Optional onCompositionEndCapture: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionEndCapture
+• Optional onCompositionStart: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionStart
+• Optional onCompositionStartCapture: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionStartCapture
+• Optional onCompositionUpdate: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionUpdate
+• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLSpanElement>
Omit.onCompositionUpdateCapture
+• Optional onContextMenu: MouseEventHandler<HTMLSpanElement>
Omit.onContextMenu
+• Optional onContextMenuCapture: MouseEventHandler<HTMLSpanElement>
Omit.onContextMenuCapture
+• Optional onCopy: ClipboardEventHandler<HTMLSpanElement>
Omit.onCopy
+• Optional onCopyCapture: ClipboardEventHandler<HTMLSpanElement>
Omit.onCopyCapture
+• Optional onCut: ClipboardEventHandler<HTMLSpanElement>
Omit.onCut
+• Optional onCutCapture: ClipboardEventHandler<HTMLSpanElement>
Omit.onCutCapture
+• Optional onDoubleClick: MouseEventHandler<HTMLSpanElement>
Omit.onDoubleClick
+• Optional onDoubleClickCapture: MouseEventHandler<HTMLSpanElement>
Omit.onDoubleClickCapture
+• Optional onDrag: DragEventHandler<HTMLSpanElement>
Omit.onDrag
+• Optional onDragCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragCapture
+• Optional onDragEnd: DragEventHandler<HTMLSpanElement>
Omit.onDragEnd
+• Optional onDragEndCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragEndCapture
+• Optional onDragEnter: DragEventHandler<HTMLSpanElement>
Omit.onDragEnter
+• Optional onDragEnterCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragEnterCapture
+• Optional onDragExit: DragEventHandler<HTMLSpanElement>
Omit.onDragExit
+• Optional onDragExitCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragExitCapture
+• Optional onDragLeave: DragEventHandler<HTMLSpanElement>
Omit.onDragLeave
+• Optional onDragLeaveCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragLeaveCapture
+• Optional onDragOver: DragEventHandler<HTMLSpanElement>
Omit.onDragOver
+• Optional onDragOverCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragOverCapture
+• Optional onDragStart: DragEventHandler<HTMLSpanElement>
Omit.onDragStart
+• Optional onDragStartCapture: DragEventHandler<HTMLSpanElement>
Omit.onDragStartCapture
+• Optional onDrop: DragEventHandler<HTMLSpanElement>
Omit.onDrop
+• Optional onDropCapture: DragEventHandler<HTMLSpanElement>
Omit.onDropCapture
+• Optional onDurationChange: ReactEventHandler<HTMLSpanElement>
Omit.onDurationChange
+• Optional onDurationChangeCapture: ReactEventHandler<HTMLSpanElement>
Omit.onDurationChangeCapture
+• Optional onEmptied: ReactEventHandler<HTMLSpanElement>
Omit.onEmptied
+• Optional onEmptiedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onEmptiedCapture
+• Optional onEncrypted: ReactEventHandler<HTMLSpanElement>
Omit.onEncrypted
+• Optional onEncryptedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onEncryptedCapture
+• Optional onEnded: ReactEventHandler<HTMLSpanElement>
Omit.onEnded
+• Optional onEndedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onEndedCapture
+• Optional onError: ReactEventHandler<HTMLSpanElement>
Omit.onError
+• Optional onErrorCapture: ReactEventHandler<HTMLSpanElement>
Omit.onErrorCapture
+• Optional onFocus: FocusEventHandler<HTMLSpanElement>
Omit.onFocus
+• Optional onFocusCapture: FocusEventHandler<HTMLSpanElement>
Omit.onFocusCapture
+• Optional onGotPointerCapture: PointerEventHandler<HTMLSpanElement>
Omit.onGotPointerCapture
+• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>
Omit.onGotPointerCaptureCapture
+• Optional onInput: FormEventHandler<HTMLSpanElement>
Omit.onInput
+• Optional onInputCapture: FormEventHandler<HTMLSpanElement>
Omit.onInputCapture
+• Optional onInvalid: FormEventHandler<HTMLSpanElement>
Omit.onInvalid
+• Optional onInvalidCapture: FormEventHandler<HTMLSpanElement>
Omit.onInvalidCapture
+• Optional onKeyDown: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyDown
+• Optional onKeyDownCapture: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyDownCapture
+• Optional onKeyPress: KeyboardEventHandler<HTMLSpanElement>
deprecated
Omit.onKeyPress
+• Optional onKeyPressCapture: KeyboardEventHandler<HTMLSpanElement>
deprecated
Omit.onKeyPressCapture
+• Optional onKeyUp: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyUp
+• Optional onKeyUpCapture: KeyboardEventHandler<HTMLSpanElement>
Omit.onKeyUpCapture
+• Optional onLoad: ReactEventHandler<HTMLSpanElement>
Omit.onLoad
+• Optional onLoadCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadCapture
+• Optional onLoadStart: ReactEventHandler<HTMLSpanElement>
Omit.onLoadStart
+• Optional onLoadStartCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadStartCapture
+• Optional onLoadedData: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedData
+• Optional onLoadedDataCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedDataCapture
+• Optional onLoadedMetadata: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedMetadata
+• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLSpanElement>
Omit.onLoadedMetadataCapture
+• Optional onLostPointerCapture: PointerEventHandler<HTMLSpanElement>
Omit.onLostPointerCapture
+• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLSpanElement>
Omit.onLostPointerCaptureCapture
+• Optional onMouseDown: MouseEventHandler<HTMLSpanElement>
Omit.onMouseDown
+• Optional onMouseDownCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseDownCapture
+• Optional onMouseEnter: MouseEventHandler<HTMLSpanElement>
Omit.onMouseEnter
+• Optional onMouseLeave: MouseEventHandler<HTMLSpanElement>
Omit.onMouseLeave
+• Optional onMouseMove: MouseEventHandler<HTMLSpanElement>
Omit.onMouseMove
+• Optional onMouseMoveCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseMoveCapture
+• Optional onMouseOut: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOut
+• Optional onMouseOutCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOutCapture
+• Optional onMouseOver: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOver
+• Optional onMouseOverCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseOverCapture
+• Optional onMouseUp: MouseEventHandler<HTMLSpanElement>
Omit.onMouseUp
+• Optional onMouseUpCapture: MouseEventHandler<HTMLSpanElement>
Omit.onMouseUpCapture
+• Optional onPaste: ClipboardEventHandler<HTMLSpanElement>
Omit.onPaste
+• Optional onPasteCapture: ClipboardEventHandler<HTMLSpanElement>
Omit.onPasteCapture
+• Optional onPause: ReactEventHandler<HTMLSpanElement>
Omit.onPause
+• Optional onPauseCapture: ReactEventHandler<HTMLSpanElement>
Omit.onPauseCapture
+• Optional onPlay: ReactEventHandler<HTMLSpanElement>
Omit.onPlay
+• Optional onPlayCapture: ReactEventHandler<HTMLSpanElement>
Omit.onPlayCapture
+• Optional onPlaying: ReactEventHandler<HTMLSpanElement>
Omit.onPlaying
+• Optional onPlayingCapture: ReactEventHandler<HTMLSpanElement>
Omit.onPlayingCapture
+• Optional onPointerCancel: PointerEventHandler<HTMLSpanElement>
Omit.onPointerCancel
+• Optional onPointerCancelCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerCancelCapture
+• Optional onPointerDown: PointerEventHandler<HTMLSpanElement>
Omit.onPointerDown
+• Optional onPointerDownCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerDownCapture
+• Optional onPointerEnter: PointerEventHandler<HTMLSpanElement>
Omit.onPointerEnter
+• Optional onPointerEnterCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerEnterCapture
+• Optional onPointerLeave: PointerEventHandler<HTMLSpanElement>
Omit.onPointerLeave
+• Optional onPointerLeaveCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerLeaveCapture
+• Optional onPointerMove: PointerEventHandler<HTMLSpanElement>
Omit.onPointerMove
+• Optional onPointerMoveCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerMoveCapture
+• Optional onPointerOut: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOut
+• Optional onPointerOutCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOutCapture
+• Optional onPointerOver: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOver
+• Optional onPointerOverCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerOverCapture
+• Optional onPointerUp: PointerEventHandler<HTMLSpanElement>
Omit.onPointerUp
+• Optional onPointerUpCapture: PointerEventHandler<HTMLSpanElement>
Omit.onPointerUpCapture
+• Optional onProgress: ReactEventHandler<HTMLSpanElement>
Omit.onProgress
+• Optional onProgressCapture: ReactEventHandler<HTMLSpanElement>
Omit.onProgressCapture
+• Optional onRateChange: ReactEventHandler<HTMLSpanElement>
Omit.onRateChange
+• Optional onRateChangeCapture: ReactEventHandler<HTMLSpanElement>
Omit.onRateChangeCapture
+• Optional onReset: FormEventHandler<HTMLSpanElement>
Omit.onReset
+• Optional onResetCapture: FormEventHandler<HTMLSpanElement>
Omit.onResetCapture
+• Optional onScroll: UIEventHandler<HTMLSpanElement>
Omit.onScroll
+• Optional onScrollCapture: UIEventHandler<HTMLSpanElement>
Omit.onScrollCapture
+• Optional onSeeked: ReactEventHandler<HTMLSpanElement>
Omit.onSeeked
+• Optional onSeekedCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSeekedCapture
+• Optional onSeeking: ReactEventHandler<HTMLSpanElement>
Omit.onSeeking
+• Optional onSeekingCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSeekingCapture
+• Optional onSelect: ReactEventHandler<HTMLSpanElement>
Omit.onSelect
+• Optional onSelectCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSelectCapture
+• Optional onStalled: ReactEventHandler<HTMLSpanElement>
Omit.onStalled
+• Optional onStalledCapture: ReactEventHandler<HTMLSpanElement>
Omit.onStalledCapture
+• Optional onSubmit: FormEventHandler<HTMLSpanElement>
Omit.onSubmit
+• Optional onSubmitCapture: FormEventHandler<HTMLSpanElement>
Omit.onSubmitCapture
+• Optional onSuspend: ReactEventHandler<HTMLSpanElement>
Omit.onSuspend
+• Optional onSuspendCapture: ReactEventHandler<HTMLSpanElement>
Omit.onSuspendCapture
+• Optional onTimeUpdate: ReactEventHandler<HTMLSpanElement>
Omit.onTimeUpdate
+• Optional onTimeUpdateCapture: ReactEventHandler<HTMLSpanElement>
Omit.onTimeUpdateCapture
+• Optional onTouchCancel: TouchEventHandler<HTMLSpanElement>
Omit.onTouchCancel
+• Optional onTouchCancelCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchCancelCapture
+• Optional onTouchEnd: TouchEventHandler<HTMLSpanElement>
Omit.onTouchEnd
+• Optional onTouchEndCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchEndCapture
+• Optional onTouchMove: TouchEventHandler<HTMLSpanElement>
Omit.onTouchMove
+• Optional onTouchMoveCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchMoveCapture
+• Optional onTouchStart: TouchEventHandler<HTMLSpanElement>
Omit.onTouchStart
+• Optional onTouchStartCapture: TouchEventHandler<HTMLSpanElement>
Omit.onTouchStartCapture
+• Optional onTransitionEnd: TransitionEventHandler<HTMLSpanElement>
Omit.onTransitionEnd
+• Optional onTransitionEndCapture: TransitionEventHandler<HTMLSpanElement>
Omit.onTransitionEndCapture
+• Optional onVolumeChange: ReactEventHandler<HTMLSpanElement>
Omit.onVolumeChange
+• Optional onVolumeChangeCapture: ReactEventHandler<HTMLSpanElement>
Omit.onVolumeChangeCapture
+• Optional onWaiting: ReactEventHandler<HTMLSpanElement>
Omit.onWaiting
+• Optional onWaitingCapture: ReactEventHandler<HTMLSpanElement>
Omit.onWaitingCapture
+• Optional onWheel: WheelEventHandler<HTMLSpanElement>
Omit.onWheel
+• Optional onWheelCapture: WheelEventHandler<HTMLSpanElement>
Omit.onWheelCapture
+• Optional orientation: "horizontal" | "vertical"
Omit.orientation
+• Optional placeholder: string
Omit.placeholder
+• Optional prefix: string
Omit.prefix
+• Optional property: string
Omit.property
+• Optional radioGroup: string
Omit.radioGroup
+• Optional ref: null | (instance: null | HTMLSpanElement) => void | RefObject<HTMLSpanElement>
Omit.ref
+• Optional resource: string
Omit.resource
+• Optional results: number
Omit.results
+• Optional role: AriaRole
Omit.role
+▸ Optional scale(value): number
• Optional scale: (value: number) => number
▸ (value): number
number
Omit.scale
+• Optional security: string
Omit.security
+• Optional slot: string
Omit.slot
+• Optional spellCheck: Booleanish
Omit.spellCheck
+• Optional step: null | number
Omit.step
+• Optional style: CSSProperties
Omit.style
+• Optional suppressContentEditableWarning: boolean
Omit.suppressContentEditableWarning
+• Optional suppressHydrationWarning: boolean
Omit.suppressHydrationWarning
+• Optional tabIndex: number
Omit.tabIndex
+• Optional title: string
Omit.title
+• Optional track: false | "normal" | "inverted"
Omit.track
+• Optional translate: "yes" | "no"
Omit.translate
+• Optional typeof: string
Omit.typeof
+• Optional unselectable: "on" | "off"
Omit.unselectable
+• Optional value: number | number[]
Omit.value
+• Optional valueLabelDisplay: "on" | "off" | "auto"
Omit.valueLabelDisplay
+• Optional valueLabelFormat: string | (value: number, index: number) => ReactNode
Omit.valueLabelFormat
+• Optional vocab: string
Omit.vocab
+▸ onChange(evt, value): void
| Name | +Type | +
|---|---|
evt |
+FormEvent<any> |
+
value |
+number |
+
void
• Optional about: string
Omit.onCanPlayThroughCapture
• Optional onChange: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void
▸ (checked, event): void
| Name | +Type | +
|---|---|
checked |
+boolean |
+
event |
+ChangeEvent<HTMLInputElement> |
+
void
• Optional onChangeCapture: FormEventHandler<HTMLInputElement>
Optional wrap: string
Omit.wrap
-▸ Optional onChange(checked, event): void
| Name | -Type | -
|---|---|
checked |
-boolean |
-
event |
-ChangeEvent<HTMLInputElement> |
-
void
• Optional TouchRippleProps: Partial<TouchRippleProps>
SwitchProps.onCanPlayThroughCapture
• Optional onChangeCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onChangeCapture
-• Optional onClick: MouseEventHandler<HTMLButtonElement>
SwitchProps.onClick
-• Optional onClickCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onClickCapture
-• Optional onCompositionEnd: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionEnd
-• Optional onCompositionEndCapture: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionEndCapture
-• Optional onCompositionStart: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionStart
-• Optional onCompositionStartCapture: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionStartCapture
-• Optional onCompositionUpdate: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionUpdate
-• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionUpdateCapture
-• Optional onContextMenu: MouseEventHandler<HTMLButtonElement>
SwitchProps.onContextMenu
-• Optional onContextMenuCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onContextMenuCapture
-• Optional onCopy: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCopy
-• Optional onCopyCapture: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCopyCapture
-• Optional onCut: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCut
-• Optional onCutCapture: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCutCapture
-• Optional onDoubleClick: MouseEventHandler<HTMLButtonElement>
SwitchProps.onDoubleClick
-• Optional onDoubleClickCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onDoubleClickCapture
-• Optional onDrag: DragEventHandler<HTMLButtonElement>
SwitchProps.onDrag
-• Optional onDragCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragCapture
-• Optional onDragEnd: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEnd
-• Optional onDragEndCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEndCapture
-• Optional onDragEnter: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEnter
-• Optional onDragEnterCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEnterCapture
-• Optional onDragExit: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragExit
-• Optional onDragExitCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragExitCapture
-• Optional onDragLeave: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragLeave
-• Optional onDragLeaveCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragLeaveCapture
-• Optional onDragOver: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragOver
-• Optional onDragOverCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragOverCapture
-• Optional onDragStart: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragStart
-• Optional onDragStartCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragStartCapture
-• Optional onDrop: DragEventHandler<HTMLButtonElement>
SwitchProps.onDrop
-• Optional onDropCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDropCapture
-• Optional onDurationChange: ReactEventHandler<HTMLButtonElement>
SwitchProps.onDurationChange
-• Optional onDurationChangeCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onDurationChangeCapture
-• Optional onEmptied: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEmptied
-• Optional onEmptiedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEmptiedCapture
-• Optional onEncrypted: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEncrypted
-• Optional onEncryptedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEncryptedCapture
-• Optional onEnded: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEnded
-• Optional onEndedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEndedCapture
-• Optional onError: ReactEventHandler<HTMLButtonElement>
SwitchProps.onError
-• Optional onErrorCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onErrorCapture
-• Optional onFocus: FocusEventHandler<HTMLButtonElement>
SwitchProps.onFocus
-• Optional onFocusCapture: FocusEventHandler<HTMLButtonElement>
SwitchProps.onFocusCapture
-• Optional onFocusVisible: FocusEventHandler<any>
Callback fired when the component is focused with a keyboard.
-We trigger a onFocus callback too.
SwitchProps.onFocusVisible
-• Optional onGotPointerCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onGotPointerCapture
-• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onGotPointerCaptureCapture
-• Optional onInput: FormEventHandler<HTMLButtonElement>
SwitchProps.onInput
-• Optional onInputCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onInputCapture
-• Optional onInvalid: FormEventHandler<HTMLButtonElement>
SwitchProps.onInvalid
-• Optional onInvalidCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onInvalidCapture
-• Optional onKeyDown: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyDown
-• Optional onKeyDownCapture: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyDownCapture
-• Optional onKeyPress: KeyboardEventHandler<HTMLButtonElement>
deprecated
SwitchProps.onKeyPress
-• Optional onKeyPressCapture: KeyboardEventHandler<HTMLButtonElement>
deprecated
SwitchProps.onKeyPressCapture
-• Optional onKeyUp: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyUp
-• Optional onKeyUpCapture: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyUpCapture
-• Optional onLoad: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoad
-• Optional onLoadCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadCapture
-• Optional onLoadStart: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadStart
-• Optional onLoadStartCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadStartCapture
-• Optional onLoadedData: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedData
-• Optional onLoadedDataCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedDataCapture
-• Optional onLoadedMetadata: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedMetadata
-• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedMetadataCapture
-• Optional onLostPointerCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onLostPointerCapture
-• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onLostPointerCaptureCapture
-• Optional onMouseDown: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseDown
-• Optional onMouseDownCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseDownCapture
-• Optional onMouseEnter: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseEnter
-• Optional onMouseLeave: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseLeave
-• Optional onMouseMove: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseMove
-• Optional onMouseMoveCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseMoveCapture
-• Optional onMouseOut: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOut
-• Optional onMouseOutCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOutCapture
-• Optional onMouseOver: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOver
-• Optional onMouseOverCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOverCapture
-• Optional onMouseUp: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseUp
-• Optional onMouseUpCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseUpCapture
-• Optional onPaste: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onPaste
-• Optional onPasteCapture: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onPasteCapture
-• Optional onPause: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPause
-• Optional onPauseCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPauseCapture
-• Optional onPlay: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlay
-• Optional onPlayCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlayCapture
-• Optional onPlaying: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlaying
-• Optional onPlayingCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlayingCapture
-• Optional onPointerCancel: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerCancel
-• Optional onPointerCancelCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerCancelCapture
-• Optional onPointerDown: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerDown
-• Optional onPointerDownCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerDownCapture
-• Optional onPointerEnter: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerEnter
-• Optional onPointerEnterCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerEnterCapture
-• Optional onPointerLeave: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerLeave
-• Optional onPointerLeaveCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerLeaveCapture
-• Optional onPointerMove: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerMove
-• Optional onPointerMoveCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerMoveCapture
-• Optional onPointerOut: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOut
-• Optional onPointerOutCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOutCapture
-• Optional onPointerOver: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOver
-• Optional onPointerOverCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOverCapture
-• Optional onPointerUp: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerUp
-• Optional onPointerUpCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerUpCapture
-• Optional onProgress: ReactEventHandler<HTMLButtonElement>
SwitchProps.onProgress
-• Optional onProgressCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onProgressCapture
-• Optional onRateChange: ReactEventHandler<HTMLButtonElement>
SwitchProps.onRateChange
-• Optional onRateChangeCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onRateChangeCapture
-• Optional onReset: FormEventHandler<HTMLButtonElement>
SwitchProps.onReset
-• Optional onResetCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onResetCapture
-• Optional onScroll: UIEventHandler<HTMLButtonElement>
SwitchProps.onScroll
-• Optional onScrollCapture: UIEventHandler<HTMLButtonElement>
SwitchProps.onScrollCapture
-• Optional onSeeked: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeeked
-• Optional onSeekedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeekedCapture
-• Optional onSeeking: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeeking
-• Optional onSeekingCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeekingCapture
-• Optional onSelect: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSelect
-• Optional onSelectCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSelectCapture
-• Optional onStalled: ReactEventHandler<HTMLButtonElement>
SwitchProps.onStalled
-• Optional onStalledCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onStalledCapture
-• Optional onSubmit: FormEventHandler<HTMLButtonElement>
SwitchProps.onSubmit
-• Optional onSubmitCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onSubmitCapture
-• Optional onSuspend: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSuspend
-• Optional onSuspendCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSuspendCapture
-• Optional onTimeUpdate: ReactEventHandler<HTMLButtonElement>
SwitchProps.onTimeUpdate
-• Optional onTimeUpdateCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onTimeUpdateCapture
-• Optional onTouchCancel: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchCancel
-• Optional onTouchCancelCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchCancelCapture
-• Optional onTouchEnd: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchEnd
-• Optional onTouchEndCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchEndCapture
-• Optional onTouchMove: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchMove
-• Optional onTouchMoveCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchMoveCapture
-• Optional onTouchStart: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchStart
-• Optional onTouchStartCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchStartCapture
-• Optional onTransitionEnd: TransitionEventHandler<HTMLButtonElement>
SwitchProps.onTransitionEnd
-• Optional onTransitionEndCapture: TransitionEventHandler<HTMLButtonElement>
SwitchProps.onTransitionEndCapture
-• Optional onVolumeChange: ReactEventHandler<HTMLButtonElement>
SwitchProps.onVolumeChange
-• Optional onVolumeChangeCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onVolumeChangeCapture
-• Optional onWaiting: ReactEventHandler<HTMLButtonElement>
SwitchProps.onWaiting
-• Optional onWaitingCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onWaitingCapture
-• Optional onWheel: WheelEventHandler<HTMLButtonElement>
SwitchProps.onWheel
-• Optional onWheelCapture: WheelEventHandler<HTMLButtonElement>
SwitchProps.onWheelCapture
-• Optional placeholder: string
SwitchProps.placeholder
-• Optional prefix: string
SwitchProps.prefix
-• Optional property: string
SwitchProps.property
-• Optional radioGroup: string
SwitchProps.radioGroup
-• Optional readOnly: boolean
SwitchProps.readOnly
-• Optional ref: null | (instance: null | HTMLButtonElement) => void | RefObject<HTMLButtonElement>
SwitchProps.ref
-• Optional required: boolean
If true, the input element will be required.
SwitchProps.required
-• Optional resource: string
SwitchProps.resource
-• Optional results: number
SwitchProps.results
-• Optional role: AriaRole
SwitchProps.role
-• Optional security: string
SwitchProps.security
-• Optional size: "small" | "medium"
The size of the switch.
-small is equivalent to the dense switch styling.
SwitchProps.size
-• Optional slot: string
SwitchProps.slot
-• Optional spellCheck: Booleanish
SwitchProps.spellCheck
-• Optional style: CSSProperties
SwitchProps.style
-• Optional suppressContentEditableWarning: boolean
SwitchProps.suppressContentEditableWarning
-• Optional suppressHydrationWarning: boolean
SwitchProps.suppressHydrationWarning
-• Optional tabIndex: number
SwitchProps.tabIndex
-• Optional title: string
SwitchProps.title
-• Optional translate: "yes" | "no"
SwitchProps.translate
-• Optional type: HTMLInputTypeAttribute
SwitchProps.type
-• Optional typeof: string
SwitchProps.typeof
-• Optional unselectable: "on" | "off"
SwitchProps.unselectable
-• Optional value: unknown
The value of the component. The DOM API casts this to a string. -The browser uses "on" as the default value.
-SwitchProps.value
-• Optional vocab: string
SwitchProps.vocab
-▸ Optional onChange(event, checked): void
• Optional onChange: (event: ChangeEvent<HTMLInputElement>, checked: boolean) => void
▸ (event, checked): void
Callback fired when the state is changed.
-void
SwitchProps.onChange
+• Optional onChangeCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onChangeCapture
+• Optional onClick: MouseEventHandler<HTMLButtonElement>
SwitchProps.onClick
+• Optional onClickCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onClickCapture
+• Optional onCompositionEnd: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionEnd
+• Optional onCompositionEndCapture: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionEndCapture
+• Optional onCompositionStart: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionStart
+• Optional onCompositionStartCapture: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionStartCapture
+• Optional onCompositionUpdate: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionUpdate
+• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLButtonElement>
SwitchProps.onCompositionUpdateCapture
+• Optional onContextMenu: MouseEventHandler<HTMLButtonElement>
SwitchProps.onContextMenu
+• Optional onContextMenuCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onContextMenuCapture
+• Optional onCopy: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCopy
+• Optional onCopyCapture: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCopyCapture
+• Optional onCut: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCut
+• Optional onCutCapture: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onCutCapture
+• Optional onDoubleClick: MouseEventHandler<HTMLButtonElement>
SwitchProps.onDoubleClick
+• Optional onDoubleClickCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onDoubleClickCapture
+• Optional onDrag: DragEventHandler<HTMLButtonElement>
SwitchProps.onDrag
+• Optional onDragCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragCapture
+• Optional onDragEnd: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEnd
+• Optional onDragEndCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEndCapture
+• Optional onDragEnter: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEnter
+• Optional onDragEnterCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragEnterCapture
+• Optional onDragExit: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragExit
+• Optional onDragExitCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragExitCapture
+• Optional onDragLeave: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragLeave
+• Optional onDragLeaveCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragLeaveCapture
+• Optional onDragOver: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragOver
+• Optional onDragOverCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragOverCapture
+• Optional onDragStart: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragStart
+• Optional onDragStartCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDragStartCapture
+• Optional onDrop: DragEventHandler<HTMLButtonElement>
SwitchProps.onDrop
+• Optional onDropCapture: DragEventHandler<HTMLButtonElement>
SwitchProps.onDropCapture
+• Optional onDurationChange: ReactEventHandler<HTMLButtonElement>
SwitchProps.onDurationChange
+• Optional onDurationChangeCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onDurationChangeCapture
+• Optional onEmptied: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEmptied
+• Optional onEmptiedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEmptiedCapture
+• Optional onEncrypted: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEncrypted
+• Optional onEncryptedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEncryptedCapture
+• Optional onEnded: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEnded
+• Optional onEndedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onEndedCapture
+• Optional onError: ReactEventHandler<HTMLButtonElement>
SwitchProps.onError
+• Optional onErrorCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onErrorCapture
+• Optional onFocus: FocusEventHandler<HTMLButtonElement>
SwitchProps.onFocus
+• Optional onFocusCapture: FocusEventHandler<HTMLButtonElement>
SwitchProps.onFocusCapture
+• Optional onFocusVisible: FocusEventHandler<any>
Callback fired when the component is focused with a keyboard.
+We trigger a onFocus callback too.
SwitchProps.onFocusVisible
+• Optional onGotPointerCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onGotPointerCapture
+• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onGotPointerCaptureCapture
+• Optional onInput: FormEventHandler<HTMLButtonElement>
SwitchProps.onInput
+• Optional onInputCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onInputCapture
+• Optional onInvalid: FormEventHandler<HTMLButtonElement>
SwitchProps.onInvalid
+• Optional onInvalidCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onInvalidCapture
+• Optional onKeyDown: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyDown
+• Optional onKeyDownCapture: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyDownCapture
+• Optional onKeyPress: KeyboardEventHandler<HTMLButtonElement>
deprecated
SwitchProps.onKeyPress
+• Optional onKeyPressCapture: KeyboardEventHandler<HTMLButtonElement>
deprecated
SwitchProps.onKeyPressCapture
+• Optional onKeyUp: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyUp
+• Optional onKeyUpCapture: KeyboardEventHandler<HTMLButtonElement>
SwitchProps.onKeyUpCapture
+• Optional onLoad: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoad
+• Optional onLoadCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadCapture
+• Optional onLoadStart: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadStart
+• Optional onLoadStartCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadStartCapture
+• Optional onLoadedData: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedData
+• Optional onLoadedDataCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedDataCapture
+• Optional onLoadedMetadata: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedMetadata
+• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onLoadedMetadataCapture
+• Optional onLostPointerCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onLostPointerCapture
+• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onLostPointerCaptureCapture
+• Optional onMouseDown: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseDown
+• Optional onMouseDownCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseDownCapture
+• Optional onMouseEnter: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseEnter
+• Optional onMouseLeave: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseLeave
+• Optional onMouseMove: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseMove
+• Optional onMouseMoveCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseMoveCapture
+• Optional onMouseOut: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOut
+• Optional onMouseOutCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOutCapture
+• Optional onMouseOver: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOver
+• Optional onMouseOverCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseOverCapture
+• Optional onMouseUp: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseUp
+• Optional onMouseUpCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onMouseUpCapture
+• Optional onPaste: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onPaste
+• Optional onPasteCapture: ClipboardEventHandler<HTMLButtonElement>
SwitchProps.onPasteCapture
+• Optional onPause: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPause
+• Optional onPauseCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPauseCapture
+• Optional onPlay: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlay
+• Optional onPlayCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlayCapture
+• Optional onPlaying: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlaying
+• Optional onPlayingCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onPlayingCapture
+• Optional onPointerCancel: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerCancel
+• Optional onPointerCancelCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerCancelCapture
+• Optional onPointerDown: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerDown
+• Optional onPointerDownCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerDownCapture
+• Optional onPointerEnter: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerEnter
+• Optional onPointerEnterCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerEnterCapture
+• Optional onPointerLeave: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerLeave
+• Optional onPointerLeaveCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerLeaveCapture
+• Optional onPointerMove: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerMove
+• Optional onPointerMoveCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerMoveCapture
+• Optional onPointerOut: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOut
+• Optional onPointerOutCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOutCapture
+• Optional onPointerOver: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOver
+• Optional onPointerOverCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerOverCapture
+• Optional onPointerUp: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerUp
+• Optional onPointerUpCapture: PointerEventHandler<HTMLButtonElement>
SwitchProps.onPointerUpCapture
+• Optional onProgress: ReactEventHandler<HTMLButtonElement>
SwitchProps.onProgress
+• Optional onProgressCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onProgressCapture
+• Optional onRateChange: ReactEventHandler<HTMLButtonElement>
SwitchProps.onRateChange
+• Optional onRateChangeCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onRateChangeCapture
+• Optional onReset: FormEventHandler<HTMLButtonElement>
SwitchProps.onReset
+• Optional onResetCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onResetCapture
+• Optional onScroll: UIEventHandler<HTMLButtonElement>
SwitchProps.onScroll
+• Optional onScrollCapture: UIEventHandler<HTMLButtonElement>
SwitchProps.onScrollCapture
+• Optional onSeeked: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeeked
+• Optional onSeekedCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeekedCapture
+• Optional onSeeking: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeeking
+• Optional onSeekingCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSeekingCapture
+• Optional onSelect: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSelect
+• Optional onSelectCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSelectCapture
+• Optional onStalled: ReactEventHandler<HTMLButtonElement>
SwitchProps.onStalled
+• Optional onStalledCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onStalledCapture
+• Optional onSubmit: FormEventHandler<HTMLButtonElement>
SwitchProps.onSubmit
+• Optional onSubmitCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onSubmitCapture
+• Optional onSuspend: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSuspend
+• Optional onSuspendCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onSuspendCapture
+• Optional onTimeUpdate: ReactEventHandler<HTMLButtonElement>
SwitchProps.onTimeUpdate
+• Optional onTimeUpdateCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onTimeUpdateCapture
+• Optional onTouchCancel: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchCancel
+• Optional onTouchCancelCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchCancelCapture
+• Optional onTouchEnd: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchEnd
+• Optional onTouchEndCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchEndCapture
+• Optional onTouchMove: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchMove
+• Optional onTouchMoveCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchMoveCapture
+• Optional onTouchStart: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchStart
+• Optional onTouchStartCapture: TouchEventHandler<HTMLButtonElement>
SwitchProps.onTouchStartCapture
+• Optional onTransitionEnd: TransitionEventHandler<HTMLButtonElement>
SwitchProps.onTransitionEnd
+• Optional onTransitionEndCapture: TransitionEventHandler<HTMLButtonElement>
SwitchProps.onTransitionEndCapture
+• Optional onVolumeChange: ReactEventHandler<HTMLButtonElement>
SwitchProps.onVolumeChange
+• Optional onVolumeChangeCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onVolumeChangeCapture
+• Optional onWaiting: ReactEventHandler<HTMLButtonElement>
SwitchProps.onWaiting
+• Optional onWaitingCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onWaitingCapture
+• Optional onWheel: WheelEventHandler<HTMLButtonElement>
SwitchProps.onWheel
+• Optional onWheelCapture: WheelEventHandler<HTMLButtonElement>
SwitchProps.onWheelCapture
+• Optional placeholder: string
SwitchProps.placeholder
+• Optional prefix: string
SwitchProps.prefix
+• Optional property: string
SwitchProps.property
+• Optional radioGroup: string
SwitchProps.radioGroup
+• Optional readOnly: boolean
SwitchProps.readOnly
+• Optional ref: null | (instance: null | HTMLButtonElement) => void | RefObject<HTMLButtonElement>
SwitchProps.ref
+• Optional required: boolean
If true, the input element will be required.
SwitchProps.required
+• Optional resource: string
SwitchProps.resource
+• Optional results: number
SwitchProps.results
+• Optional role: AriaRole
SwitchProps.role
+• Optional security: string
SwitchProps.security
+• Optional size: "small" | "medium"
The size of the switch.
+small is equivalent to the dense switch styling.
SwitchProps.size
+• Optional slot: string
SwitchProps.slot
+• Optional spellCheck: Booleanish
SwitchProps.spellCheck
+• Optional style: CSSProperties
SwitchProps.style
+• Optional suppressContentEditableWarning: boolean
SwitchProps.suppressContentEditableWarning
+• Optional suppressHydrationWarning: boolean
SwitchProps.suppressHydrationWarning
+• Optional tabIndex: number
SwitchProps.tabIndex
+• Optional title: string
SwitchProps.title
+• Optional translate: "yes" | "no"
SwitchProps.translate
+• Optional type: HTMLInputTypeAttribute
SwitchProps.type
+• Optional typeof: string
SwitchProps.typeof
+• Optional unselectable: "on" | "off"
SwitchProps.unselectable
+• Optional value: unknown
The value of the component. The DOM API casts this to a string. +The browser uses "on" as the default value.
+SwitchProps.value
+• Optional vocab: string
SwitchProps.vocab
diff --git a/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html b/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html index 35f1574017..bd27afe923 100644 --- a/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.TableProps/index.html @@ -738,13 +738,6 @@ Properties - - -• Optional autoSize: boolean
• Optional className: string
• Optional customRowHeights: (item: Item, lineHeight: number, paddings: number) => number
▸ (item, lineHeight, paddings): number
| Name | +Type | +
|---|---|
item |
+Item |
+
lineHeight |
+number |
+
paddings |
+number |
+
number
• Optional dangerouslySetInnerHTML: Object
| Name | +Type | +
|---|---|
uid |
+string |
+
undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
• Optional items: Item[]
React.DOMAttributes.onSelectCapture
• Optional onSort: (params: TableSortParams) => void
▸ (params): void
| Name | +Type | +
|---|---|
params |
+TableSortParams |
+
void
• Optional onStalled: ReactEventHandler<HTMLDivElement>
React.DOMAttributes.onWheelCapture
• Optional renderRow: (item: Item) => undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
▸ (item): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
| Name | +Type | +
|---|---|
item |
+Item |
+
undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
• Optional rowLineHeight: number
Row line height in pixels
@@ -3159,94 +3232,6 @@ auto sizer to fill available heightOnly used when virtual is true. Sets the virtual list to be a fixed height.
Needed when used in contexts that already have a parent component that
is overflow-y: scroll,
▸ Optional customRowHeights(item, lineHeight, paddings): number
| Name | -Type | -
|---|---|
item |
-Item |
-
lineHeight |
-number |
-
paddings |
-number |
-
number
▸ Optional getTableRow(uid): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
| Name | -Type | -
|---|---|
uid |
-string |
-
undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
▸ Optional onSort(params): void
| Name | -Type | -
|---|---|
params |
-TableSortParams |
-
void
▸ Optional renderRow(item): undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
| Name | -Type | -
|---|---|
item |
-Item |
-
undefined | null | ReactElement<TableRowProps<Item>, string | JSXElementConstructor<any>>
• Optional data: Partial<D>
• Optional hideSteps: boolean
▸ Optional done(): void
• Optional done: () => void
▸ (): void
void
• Optional hideSteps: boolean
▸ Optional reset(): void
• Optional reset: () => void
▸ (): void
void
▸ Optional save(data, callback?): void
• Optional save: (data: Partial<D>, callback?: () => void) => void
▸ (data, callback?): void
void
• Optional done: () => void
▸ (): void
void
• Optional header: ReactNode
• Optional hideSteps: boolean
• Optional step: number
• Optional title: string
▸ Optional done(): void
void
▸ Optional onChange(step): void
• Optional onChange: (step: number) => void
▸ (step): void
void
▸ Optional reset(): void
• Optional reset: () => void
▸ (): void
void
▸ Optional save(data, callback?): void
• Optional save: (data: Partial<D>, callback?: () => void) => void
▸ (data, callback?): void
void
• Optional step: number
• Optional title: string
• Optional afterContent: ReactNode
• Optional disabledNext: boolean
• Optional done: () => void
▸ (): void
void
• Optional first: () => void
▸ (): void
void
• Optional hideBackBtn: boolean
• Optional hideSteps: boolean
• Optional isFirst: () => boolean
▸ (): boolean
boolean
• Optional isLast: () => boolean
▸ (): boolean
boolean
• Optional last: () => void
▸ (): void
void
• Optional loading: boolean
• Optional moreButtons: ReactNode
• Optional next: () => boolean | void | Promise<any>
▸ (): boolean | void | Promise<any>
boolean | void | Promise<any>
• Optional nextLabel: ReactNode
• Optional noValidate: boolean
• Optional prev: () => void
▸ (): void
void
• Optional prevLabel: ReactNode
• Optional reset: () => void
▸ (): void
void
• Optional save: (data: Partial<D>, callback?: () => void) => void
▸ (data, callback?): void
| Name | +Type | +
|---|---|
data |
+Partial<D> |
+
callback? |
+() => void |
+
void
• Optional scrollable: boolean
• Optional wizard: Wizard<D>
▸ Optional done(): void
void
▸ Optional first(): void
void
▸ Optional isFirst(): boolean
boolean
▸ Optional isLast(): boolean
boolean
▸ Optional last(): void
void
▸ Optional next(): boolean | void | Promise<any>
boolean | void | Promise<any>
▸ Optional prev(): void
void
▸ Optional reset(): void
void
▸ Optional save(data, callback?): void
| Name | -Type | -
|---|---|
data |
-Partial<D> |
-
callback? |
-() => void |
-
void
▸ isAllowedResource(...args): boolean
Copyright (c) OpenLens Authors. All rights reserved. -Licensed under MIT License. See LICENSE in root directory for more information.
+deprecated This function never works
boolean
false
diff --git a/master/extensions/api/modules/Main.Power/index.html b/master/extensions/api/modules/Main.Power/index.html index 8960dc6747..9847c75ee3 100644 --- a/master/extensions/api/modules/Main.Power/index.html +++ b/master/extensions/api/modules/Main.Power/index.html @@ -830,63 +830,76 @@▸ onResume(listener): Disposer
Adds event listener to system resume event
| Name | Type | +Description |
|---|---|---|
listener |
PowerEventListener |
+function which will be called on system resume |
Disposer
function to remove event listener
▸ onShutdown(listener): Disposer
Adds event listener to the event which is emitted when +the system is about to reboot or shut down
| Name | Type | +Description |
|---|---|---|
listener |
PowerEventListener |
+function which will be called on system shutdown |
Disposer
function to remove event listener
▸ onSuspend(listener): Disposer
Adds event listener to system suspend events
| Name | Type | +Description |
|---|---|---|
listener |
PowerEventListener |
+function which will be called on system suspend |
Disposer
function to remove event listener
diff --git a/master/extensions/api/modules/Renderer.Component/index.html b/master/extensions/api/modules/Renderer.Component/index.html index b748933a32..0cf8cff639 100644 --- a/master/extensions/api/modules/Renderer.Component/index.html +++ b/master/extensions/api/modules/Renderer.Component/index.html @@ -955,60 +955,11 @@• Const Badge: FunctionComponent<BadgeProps & TooltipDecoratorProps>
• Const BarChart: FunctionComponent<BarChartProps>
• Const Button: FunctionComponent<ButtonProps & TooltipDecoratorProps>
• Const CommandOverlay: CommandOverlay
• Const ConfirmDialog: FunctionComponent<ConfirmDialogProps> & { confirm: Confirm ; open: OpenConfirmDialog }
• Const Dialog: FunctionComponent<DialogProps>
• Const Drawer: FunctionComponent<DrawerProps>
• Const Icon: FunctionComponent<IconProps & TooltipDecoratorProps> & { isSvg: (content: string) => boolean }
• InputValidators: Object
• Const KubeEventDetails: FunctionComponent<KubeEventDetailsProps>
• Const KubeObjectDetails: FunctionComponent<{}>
• Const KubeObjectMeta: FunctionComponent<KubeObjectMetaProps>
• Const LineProgress: FunctionComponent<LineProgressProps & TooltipDecoratorProps>
• Const MainLayout: FunctionComponent<MainLayoutProps>
• Const MenuActions: FunctionComponent<MenuActionsProps>
• Const MenuContext: Context<null | Menu>
• Const MonacoEditor: ForwardRefExoticComponent<MonacoEditorProps & RefAttributes<MonacoEditorRef>>
• Const NamespaceSelectFilter: FunctionComponent<NamespaceSelectFilterProps>
• Const Notifications: FC<{}> & { checkedError: ShowCheckedErrorNotification ; error: ShowNotification ; info: ShowNotification ; ok: ShowNotification ; shortInfo: ShowNotification }
• Const PieChart: FunctionComponent<PieChartProps>
• Const StatusBrick: FunctionComponent<StatusBrickProps & TooltipDecoratorProps>
• Const Switcher: ComponentType<Pick<SwitcherProps, "key" | "value" | "id" | "icon" | "prefix" | "size" | "name" | "onError" | "type" | "required" | "className" | "dir" | "form" | "slot" | "style" | "title" | "onChange" | "defaultValue" | "tabIndex" | "readOnly" | "disabled" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "ref" | "role" | "defaultChecked" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "lang" | "placeholder" | "spellCheck" | "translate" | "radioGroup" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "innerRef" | "inputProps" | "checked" | "autoFocus" | "action" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "checkedIcon" | "disableFocusRipple" | "edge" | "buttonRef" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "onFocusVisible" | "TouchRippleProps" | "inputRef"> & StyledComponentProps<"track" | "checked" | "root" | "thumb" | "focusVisible" | "switchBase">>
deprecated Use
• Const terminalStore: TerminalStore & { sendCommand: (command: string, options: SendCommandOptions) => Promise<void> }
▸ Badge(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<BadgeProps & TooltipDecoratorProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ BarChart(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<BarChartProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ Button(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<ButtonProps & TooltipDecoratorProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ Checkbox(__namedParameters): Element
Element
▸ ConfirmDialog(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<ConfirmDialogProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ Dialog(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<DialogProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ Drawer(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<DrawerProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ DrawerItem(__namedParameters): null | Element
null | Element
▸ DrawerItemLabels(props): null | Element
null | Element
▸ DrawerTitle(__namedParameters): Element
Element
▸ FormSwitch(props): Element
deprecated Use
Element
▸ Icon(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<IconProps & TooltipDecoratorProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ KubeEventDetails(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<KubeEventDetailsProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ KubeObjectDetails(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+Object |
+
props.children? |
+ReactNode |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ KubeObjectListLayout<K, A, D>(props): ReactElement<any, string | JSXElementConstructor<any>>
ReactElement<any, string | JSXElementConstructor<any>>
ReactElement<any, string | JSXElementConstructor<any>>
▸ KubeObjectMeta(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<KubeObjectMetaProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ LineProgress(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<LineProgressProps & TooltipDecoratorProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ MainLayout(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<MainLayoutProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ MenuActions(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<MenuActionsProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ MonacoEditor(props): null | ReactElement<any, string | JSXElementConstructor<any>>
NOTE: Exotic components are not callable.
+| Name | +Type | +
|---|---|
props |
+MonacoEditorProps & RefAttributes<MonacoEditorRef> |
+
null | ReactElement<any, string | JSXElementConstructor<any>>
▸ NamespaceSelect<IsMulti>(props): JSX.Element
JSX.Element
▸ NamespaceSelectFilter(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<NamespaceSelectFilterProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ Notifications(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+Object |
+
props.children? |
+ReactNode |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ PieChart(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<PieChartProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ Radio<T>(__namedParameters): Element
Element
Element
ReactElement<any, string | JSXElementConstructor<any>>
▸ StatusBrick(props, context?): null | ReactElement<any, any>
| Name | +Type | +
|---|---|
props |
+PropsWithChildren<StatusBrickProps & TooltipDecoratorProps> |
+
context? |
+any |
+
null | ReactElement<any, any>
▸ SubMenu(props): Element
Element
▸ Switch(__namedParameters): Element
Element
▸ TabLayout(__namedParameters): Element
Element
ReactElement<any, string | JSXElementConstructor<any>>
▸ asyncInputValidator(validator): AsyncInputValidator
A helper function to create an AsyncInputValidator
-AsyncInputValidator
▸ createTerminalTab(tabParams?): Required<DockTabCreate>
Required<DockTabCreate>
▸ getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string
string
▸ inputValidator(validator): SyncInputValidator
A helper function to create an SyncInputValidator
-SyncInputValidator
▸ isAsyncValidator(validator): validator is AsyncInputValidator
validator is AsyncInputValidator
▸ isSvg(content): boolean
boolean
SelectProps<Value, Option, true, Group>["onChange"]
▸ showDetails(selfLink, resetSelected?): void
default resetSelected true
void
▸ unionInputValidatorsAsync(baseValidator, ...validators): AsyncInputValidator
Create a new input validator from a list of syncronous or async input validators. Will match as valid if one of the input validators matches the input
-AsyncInputValidator
React.FunctionComponent<TargetProps & TooltipDecoratorProps>