Interface: WebLinkSpec#
+ +Table of contents#
+Properties#
+-
+
- url +
Properties#
+url#
+• url: string
From 94dec396c5d74cae9f123bad70ccface5422a72d Mon Sep 17 00:00:00 2001
From: GitHub Action
CatalogEntity<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>CatalogEntity<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>↳ WebLink
__namedParametersCatalogEntityData<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>CatalogEntityData<CatalogEntityMetadata, WebLinkStatus, WebLinkSpec>• spec: WebLinkSpec
• spec: WebLinkSpec
• Readonly [IpcPrefix]: string
IpcRegistrar.__@IpcPrefix@47827
+IpcRegistrar.__@IpcPrefix@48872
• Protected extension: LensExtension
• [Disposers]: ExtendableDisposer
LensExtension.__@Disposers@9935
+LensExtension.__@Disposers@9930
• appMenus: MenuRegistration[] = []
void
LensExtension.__@setLensExtensionDependencies@9939
+LensExtension.__@setLensExtensionDependencies@9934
▸ activate(): Promise<void>
Component<Props>Component<BarChartProps>↳ BarChart
propsProps | Readonly<Props>BarChartProps | Readonly<BarChartProps>React.Component<Props>.constructor
+React.Component<BarChartProps>.constructor
• new BarChart(props, context)
deprecated
see https://reactjs.org/docs/legacy-context.html
propsPropsBarChartPropscontextReact.Component<Props>.constructor
+React.Component<BarChartProps>.constructor
• context: any
React.Component.context
• Readonly props: Readonly<Props> & Readonly<{ children?: ReactNode }>
• Readonly props: Readonly<BarChartProps> & Readonly<{ children?: ReactNode }>
React.Component.props
nextPropsReadonly<Props>Readonly<BarChartProps>nextContextnextPropsReadonly<Props>Readonly<BarChartProps>nextStateprevPropsReadonly<Props>Readonly<BarChartProps>prevStatenextPropsReadonly<Props>Readonly<BarChartProps>nextContextnextPropsReadonly<Props>Readonly<BarChartProps>nextStateprevPropsReadonly<Props>Readonly<BarChartProps>prevStatestateprevState: Readonly<{}>, props: Readonly<Props>) => {} | Pick<{}, K> | Pick<{}, K>prevState: Readonly<{}>, props: Readonly<BarChartProps>) => {} | Pick<{}, K> | Pick<{}, K>callback?componentDidUpdate will not be called.
nextPropsReadonly<Props>Readonly<BarChartProps>nextStateComponent<Props>Component<PieChartProps>↳ PieChart
propsProps | Readonly<Props>PieChartProps | Readonly<PieChartProps>React.Component<Props>.constructor
+React.Component<PieChartProps>.constructor
• new PieChart(props, context)
deprecated
see https://reactjs.org/docs/legacy-context.html
propsPropsPieChartPropscontextReact.Component<Props>.constructor
+React.Component<PieChartProps>.constructor
• context: any
React.Component.context
• Readonly props: Readonly<Props> & Readonly<{ children?: ReactNode }>
• Readonly props: Readonly<PieChartProps> & Readonly<{ children?: ReactNode }>
React.Component.props
nextPropsReadonly<Props>Readonly<PieChartProps>nextContextnextPropsReadonly<Props>Readonly<PieChartProps>nextStateprevPropsReadonly<Props>Readonly<PieChartProps>prevStatenextPropsReadonly<Props>Readonly<PieChartProps>nextContextnextPropsReadonly<Props>Readonly<PieChartProps>nextStateprevPropsReadonly<Props>Readonly<PieChartProps>prevStatestateprevState: Readonly<{}>, props: Readonly<Props>) => {} | Pick<{}, K> | Pick<{}, K>prevState: Readonly<{}>, props: Readonly<PieChartProps>) => {} | Pick<{}, K> | Pick<{}, K>callback?componentDidUpdate will not be called.
nextPropsReadonly<Props>Readonly<PieChartProps>nextStateRenderer.Component.PodDetailsList
Component<Props>Component<PodDetailsListProps>↳ PodDetailsList
propsProps | Readonly<Props>PodDetailsListProps | Readonly<PodDetailsListProps>React.Component<Props>.constructor
+React.Component<PodDetailsListProps>.constructor
• new PodDetailsList(props, context)
deprecated
see https://reactjs.org/docs/legacy-context.html
propsPropsPodDetailsListPropscontextReact.Component<Props>.constructor
+React.Component<PodDetailsListProps>.constructor
• context: any
React.Component.context
• Readonly props: Readonly<Props> & Readonly<{ children?: ReactNode }>
• Readonly props: Readonly<PodDetailsListProps> & Readonly<{ children?: ReactNode }>
React.Component.props
nextPropsReadonly<Props>Readonly<PodDetailsListProps>nextContextnextPropsReadonly<Props>Readonly<PodDetailsListProps>nextStateprevPropsReadonly<Props>Readonly<PodDetailsListProps>prevStatenextPropsReadonly<Props>Readonly<PodDetailsListProps>nextContextnextPropsReadonly<Props>Readonly<PodDetailsListProps>nextStateprevPropsReadonly<Props>Readonly<PodDetailsListProps>prevStatestateprevState: Readonly<{}>, props: Readonly<Props>) => {} | Pick<{}, K> | Pick<{}, K>prevState: Readonly<{}>, props: Readonly<PodDetailsListProps>) => {} | Pick<{}, K> | Pick<{}, K>callback?componentDidUpdate will not be called.
nextPropsReadonly<Props>Readonly<PodDetailsListProps>nextStateRenderer.Component.SearchInput
Component<Props>Component<SearchInputProps>↳ SearchInput
propsProps | Readonly<Props>SearchInputProps | Readonly<SearchInputProps>React.Component<Props>.constructor
+React.Component<SearchInputProps>.constructor
• new SearchInput(props, context)
deprecated
see https://reactjs.org/docs/legacy-context.html
propsPropsSearchInputPropscontextReact.Component<Props>.constructor
+React.Component<SearchInputProps>.constructor
• context: any
React.Component.context
• Readonly props: Readonly<Props> & Readonly<{ children?: ReactNode }>
• Readonly props: Readonly<SearchInputProps> & Readonly<{ children?: ReactNode }>
React.Component.props
nextPropsReadonly<Props>Readonly<SearchInputProps>nextContextnextPropsReadonly<Props>Readonly<SearchInputProps>nextStateprevPropsReadonly<Props>Readonly<SearchInputProps>prevStatenextPropsReadonly<Props>Readonly<SearchInputProps>nextContextnextPropsReadonly<Props>Readonly<SearchInputProps>nextStateprevPropsReadonly<Props>Readonly<SearchInputProps>prevStatestateprevState: Readonly<{}>, props: Readonly<Props>) => {} | Pick<{}, K> | Pick<{}, K>prevState: Readonly<{}>, props: Readonly<SearchInputProps>) => {} | Pick<{}, K> | Pick<{}, K>callback?componentDidUpdate will not be called.
nextPropsReadonly<Props>Readonly<SearchInputProps>nextStateComponent<Props>Component<SubTitleProps>↳ SubTitle
propsProps | Readonly<Props>SubTitleProps | Readonly<SubTitleProps>React.Component<Props>.constructor
+React.Component<SubTitleProps>.constructor
• new SubTitle(props, context)
deprecated
see https://reactjs.org/docs/legacy-context.html
propsPropsSubTitlePropscontextReact.Component<Props>.constructor
+React.Component<SubTitleProps>.constructor
• context: any
React.Component.context
• Readonly props: Readonly<Props> & Readonly<{ children?: ReactNode }>
• Readonly props: Readonly<SubTitleProps> & Readonly<{ children?: ReactNode }>
React.Component.props
nextPropsReadonly<Props>Readonly<SubTitleProps>nextContextnextPropsReadonly<Props>Readonly<SubTitleProps>nextStateprevPropsReadonly<Props>Readonly<SubTitleProps>prevStatenextPropsReadonly<Props>Readonly<SubTitleProps>nextContextnextPropsReadonly<Props>Readonly<SubTitleProps>nextStateprevPropsReadonly<Props>Readonly<SubTitleProps>prevStatestateprevState: Readonly<{}>, props: Readonly<Props>) => {} | Pick<{}, K> | Pick<{}, K>prevState: Readonly<{}>, props: Readonly<SubTitleProps>) => {} | Pick<{}, K> | Pick<{}, K>callback?componentDidUpdate will not be called.
nextPropsReadonly<Props>Readonly<SubTitleProps>nextState| Name | +
|---|
D |
+
Component<WizardProps, State>Component<WizardProps<D>, State>↳ Wizard
• new Wizard(props)
• new Wizard<D>(props)
| Name | +
|---|
D |
+
props |
-WizardProps | Readonly<WizardProps> |
+WizardProps<D> | Readonly<WizardProps<D>> |
React.Component<WizardProps, State>.constructor
-• new Wizard(props, context)
React.Component<WizardProps<D>, State>.constructor
+• new Wizard<D>(props, context)
deprecated
see https://reactjs.org/docs/legacy-context.html
| Name | +
|---|
D |
+
props |
-WizardProps |
+WizardProps<D> |
context |
@@ -1128,7 +1174,7 @@
React.Component<WizardProps, State>.constructor
+React.Component<WizardProps<D>, State>.constructor
• context: any
React.Component.context
• Readonly props: Readonly<WizardProps> & Readonly<{ children?: ReactNode }>
• Readonly props: Readonly<WizardProps<D>> & Readonly<{ children?: ReactNode }>
React.Component.props
void
• get steps(): ReactElement<WizardStepProps<any>, string | JSXElementConstructor<any>>[]
• get steps(): ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]
ReactElement<WizardStepProps<any>, string | JSXElementConstructor<any>>[]
ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]
▸ Optional UNSAFE_componentWillMount(): void
nextPropsReadonly<WizardProps>Readonly<WizardProps<D>>nextContextnextPropsReadonly<WizardProps>Readonly<WizardProps<D>>nextStateprevPropsReadonly<WizardProps>Readonly<WizardProps<D>>prevStatenextPropsReadonly<WizardProps>Readonly<WizardProps<D>>nextContextnextPropsReadonly<WizardProps>Readonly<WizardProps<D>>nextStateprevPropsReadonly<WizardProps>Readonly<WizardProps<D>>prevState▸ setState<K>(state, callback?): void
state |
-State | (prevState: Readonly<State>, props: Readonly<WizardProps>) => State | Pick<State, K> | Pick<State, K> |
+State | (prevState: Readonly<State>, props: Readonly<WizardProps<D>>) => State | Pick<State, K> | Pick<State, K> |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
callback? |
@@ -1633,7 +1679,7 @@ and |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextProps |
-Readonly<WizardProps> |
+Readonly<WizardProps<D>> |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextState |
diff --git a/master/extensions/api/classes/Renderer.Component.WizardStep/index.html b/master/extensions/api/classes/Renderer.Component.WizardStep/index.html
index c88d5a0c5c..456d451377 100644
--- a/master/extensions/api/classes/Renderer.Component.WizardStep/index.html
+++ b/master/extensions/api/classes/Renderer.Component.WizardStep/index.html
@@ -88,7 +88,7 @@
| Name | +
|---|
D |
+
Component<WizardStepProps, WizardStepState>Component<WizardStepProps<D>, WizardStepState>↳ WizardStep
• new WizardStep(props)
• new WizardStep<D>(props)
| Name | +
|---|
D |
+
props |
-WizardStepProps<any> | Readonly<WizardStepProps<any>> |
+WizardStepProps<D> | Readonly<WizardStepProps<D>> |
React.Component<WizardStepProps, WizardStepState>.constructor
-• new WizardStep(props, context)
React.Component<WizardStepProps<D>, WizardStepState>.constructor
+• new WizardStep<D>(props, context)
deprecated
see https://reactjs.org/docs/legacy-context.html
| Name | +
|---|
D |
+
props |
-WizardStepProps<any> |
+WizardStepProps<D> |
context |
@@ -1081,7 +1127,7 @@
React.Component<WizardStepProps, WizardStepState>.constructor
+React.Component<WizardStepProps<D>, WizardStepState>.constructor
• context: any
React.Component.context
• Readonly props: Readonly<WizardStepProps<any>> & Readonly<{ children?: ReactNode }>
• Readonly props: Readonly<WizardStepProps<D>> & Readonly<{ children?: ReactNode }>
React.Component.props
nextPropsReadonly<WizardStepProps<any>>Readonly<WizardStepProps<D>>nextContextnextPropsReadonly<WizardStepProps<any>>Readonly<WizardStepProps<D>>nextStateprevPropsReadonly<WizardStepProps<any>>Readonly<WizardStepProps<D>>prevStatenextPropsReadonly<WizardStepProps<any>>Readonly<WizardStepProps<D>>nextContextnextPropsReadonly<WizardStepProps<any>>Readonly<WizardStepProps<D>>nextStateprevPropsReadonly<WizardStepProps<any>>Readonly<WizardStepProps<D>>prevState▸ setState<K>(state, callback?): void
state |
-WizardStepState | (prevState: Readonly<WizardStepState>, props: Readonly<WizardStepProps<any>>) => WizardStepState | Pick<WizardStepState, K> | Pick<WizardStepState, K> |
+WizardStepState | (prevState: Readonly<WizardStepState>, props: Readonly<WizardStepProps<D>>) => WizardStepState | Pick<WizardStepState, K> | Pick<WizardStepState, K> |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
callback? |
@@ -1547,7 +1593,7 @@ and ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextProps |
-Readonly<WizardStepProps<any>> |
+Readonly<WizardStepProps<D>> |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextState |
diff --git a/master/extensions/api/classes/Renderer.Ipc/index.html b/master/extensions/api/classes/Renderer.Ipc/index.html
index 4538d339b5..aa415913d3 100644
--- a/master/extensions/api/classes/Renderer.Ipc/index.html
+++ b/master/extensions/api/classes/Renderer.Ipc/index.html
@@ -918,7 +918,7 @@
Renderer.Component.BarChartProps
+ChartProps↳ BarChartProps
• Optional className: string
ChartProps.className
+• data: ChartData
ChartProps.data
+• Optional height: string | number
ChartProps.height
+• Optional legendColors: string[]
ChartProps.legendColors
+• Optional legendPosition: "bottom"
ChartProps.legendPosition
+• Optional name: string
• Optional options: ChartOptions
ChartProps.options
+• Optional plugins: any[]
ChartProps.plugins
+• Optional redraw: boolean
ChartProps.redraw
+• Optional showChart: boolean
ChartProps.showChart
+• Optional showLegend: boolean
ChartProps.showLegend
+• Optional timeLabelStep: number
• Optional title: string
ChartProps.title
+• Optional type: ChartKind
ChartProps.type
+• Optional width: string | number
ChartProps.width
+ + + + + + + +Renderer.Component.CustomPlaceholderProps
+PlaceholderProps<OptionTypeBase, boolean>↳ CustomPlaceholderProps
• children: ReactNode
The children to be rendered.
+PlaceholderProps.children
+• Optional className: string
PlaceholderProps.className
+• hasValue: boolean
PlaceholderProps.hasValue
+• innerProps: Object
| Name | +Type | +
|---|---|
style |
+CSSProperties |
+
PlaceholderProps.innerProps
+• isDisabled: boolean
PlaceholderProps.isDisabled
+• isFocused: boolean
PlaceholderProps.isFocused
+• isMulti: boolean
PlaceholderProps.isMulti
+• options: OptionsType<OptionTypeBase>
PlaceholderProps.options
+• selectProps: Props<OptionTypeBase, false>
PlaceholderProps.selectProps
+▸ clearValue(): void
void
PlaceholderProps.clearValue
+▸ cx(state, className): string
| Name | +Type | +
|---|---|
state |
+Object |
+
className |
+string |
+
string
PlaceholderProps.cx
+▸ getStyles(name, props): Object
| Name | +Type | +
|---|---|
name |
+string |
+
props |
+any |
+
Object
PlaceholderProps.getStyles
+▸ getValue(): OptionsType<OptionType>
OptionsType<OptionType>
PlaceholderProps.getValue
+▸ selectOption(option): void
| Name | +Type | +
|---|---|
option |
+OptionType |
+
void
PlaceholderProps.selectOption
+▸ setValue(value, action): void
| Name | +Type | +
|---|---|
value |
+IsMulti extends true ? OptionsType<OptionType> : OptionType |
+
action |
+ActionTypes |
+
void
PlaceholderProps.setValue
+ + + + + + + +Renderer.Component.NamespaceSelectProps
+SelectProps↳ NamespaceSelectProps
• Optional allowCreateWhileLoading: boolean
SelectProps.allowCreateWhileLoading
+• Optional aria-label: string
• Optional aria-labelledby: string
• Optional autoConvertOptions: boolean
SelectProps.autoConvertOptions
+• Optional autoFocus: boolean
• Optional backspaceRemovesValue: boolean
SelectProps.backspaceRemovesValue
+• Optional blurInputOnSelect: boolean
• Optional captureMenuScroll: boolean
• Optional className: string
• Optional classNamePrefix: string
• Optional closeMenuOnScroll: boolean | EventListener
• Optional closeMenuOnSelect: boolean
• Optional components: Partial<SelectComponents<any, boolean>>
• Optional controlShouldRenderValue: boolean
SelectProps.controlShouldRenderValue
+• Optional createOptionPosition: "first" | "last"
SelectProps.createOptionPosition
+• Optional defaultInputValue: string
• Optional defaultMenuIsOpen: boolean
• Optional defaultValue: any
• Optional delimiter: string
• Optional escapeClearsValue: boolean
• Optional filterOption: (option: Option, rawInput: string) => boolean
▸ (option, rawInput): boolean
| Name | +Type | +
|---|---|
option |
+Option |
+
rawInput |
+string |
+
boolean
• Optional formatGroupLabel: formatGroupLabel<any>
• Optional getOptionLabel: getOptionLabel<any>
• Optional getOptionValue: getOptionValue<any>
• Optional hideSelectedOptions: boolean
SelectProps.hideSelectedOptions
+• Optional id: string
• Optional inputId: string
• Optional inputValue: string
• Optional instanceId: string | number
• Optional isClearable: boolean
• Optional isCreatable: boolean
• Optional isDisabled: boolean
• Optional isLoading: boolean
• Optional isMulti: boolean
• Optional isRtl: boolean
• Optional isSearchable: boolean
• Optional maxMenuHeight: number
• Optional menuClass: string
• Optional menuIsOpen: boolean
• Optional menuPlacement: MenuPlacement
• Optional menuPortalTarget: HTMLElement
• Optional menuPosition: MenuPosition
• Optional menuShouldBlockScroll: boolean
SelectProps.menuShouldBlockScroll
+• Optional menuShouldScrollIntoView: boolean
SelectProps.menuShouldScrollIntoView
+• Optional minMenuHeight: number
• Optional name: string
• Optional onBlur: FocusEventHandler
• Optional onFocus: FocusEventHandler
• Optional onKeyDown: KeyboardEventHandler
• Optional openMenuOnClick: boolean
• Optional openMenuOnFocus: boolean
• Optional options: OptionsType<any> | GroupedOptionsType<any>
• Optional pageSize: number
• Optional placeholder: ReactNode
• Optional showAllNamespacesOption: boolean
• Optional showIcons: boolean
• Optional styles: Partial<Styles<any, boolean>>
• Optional tabIndex: string
• Optional tabSelectsValue: boolean
• Optional theme: ThemeConfig
• Optional themeName: "lens" | "light" | "outlined" | "dark"
• Optional value: any
▸ Optional customizeOptions(options): SelectOption<any>[]
| Name | +Type | +
|---|---|
options |
+SelectOption<any>[] |
+
SelectOption<any>[]
▸ Optional formatCreateLabel(inputValue): ReactNode
| Name | +Type | +
|---|---|
inputValue |
+string |
+
ReactNode
▸ Optional formatOptionLabel(option, labelMeta): ReactNode
| Name | +Type | +
|---|---|
option |
+OptionType |
+
labelMeta |
+FormatOptionLabelMeta<OptionType, IsMulti> |
+
ReactNode
▸ Optional getNewOptionData(inputValue, optionLabel): OptionType
| Name | +Type | +
|---|---|
inputValue |
+string |
+
optionLabel |
+ReactNode |
+
OptionType
▸ Optional isOptionDisabled(option, options): boolean
| Name | +Type | +
|---|---|
option |
+OptionType |
+
options |
+OptionsType<OptionType> |
+
boolean
▸ Optional isOptionSelected(option, options): boolean
| Name | +Type | +
|---|---|
option |
+OptionType |
+
options |
+OptionsType<OptionType> |
+
boolean
▸ Optional isValidNewOption(inputValue, value, options): boolean
| Name | +Type | +
|---|---|
inputValue |
+string |
+
value |
+IsMulti extends true ? OptionsType<OptionType> : OptionType |
+
options |
+OptionsType<OptionType> | GroupedOptionsType<OptionType> |
+
boolean
▸ Optional loadingMessage(obj): string
| Name | +Type | +
|---|---|
obj |
+Object |
+
obj.inputValue |
+string |
+
string
▸ Optional noOptionsMessage(obj): string
| Name | +Type | +
|---|---|
obj |
+Object |
+
obj.inputValue |
+string |
+
string
▸ Optional onChange(option, meta?): void
| Name | +Type | +
|---|---|
option |
+any |
+
meta? |
+ActionMeta<any> |
+
void
▸ Optional onCreateOption(inputValue): void
| Name | +Type | +
|---|---|
inputValue |
+string |
+
void
▸ Optional onInputChange(newValue, actionMeta): void
| Name | +Type | +
|---|---|
newValue |
+string |
+
actionMeta |
+InputActionMeta |
+
void
▸ Optional onMenuClose(): void
void
▸ Optional onMenuOpen(): void
void
▸ Optional onMenuScrollToBottom(event): void
| Name | +Type | +
|---|---|
event |
+SyntheticEvent<HTMLElement, Event> |
+
void
SelectProps.onMenuScrollToBottom
+▸ Optional onMenuScrollToTop(event): void
| Name | +Type | +
|---|---|
event |
+SyntheticEvent<HTMLElement, Event> |
+
void
▸ Optional screenReaderStatus(obj): string
| Name | +Type | +
|---|---|
obj |
+Object |
+
obj.count |
+number |
+
string
SelectProps.screenReaderStatus
+▸ Optional sort(a, b): number
| Name | +Type | +
|---|---|
a |
+SelectOption<string> |
+
b |
+SelectOption<string> |
+
number
Renderer.Component.PieChartProps
+ChartProps↳ PieChartProps
• Optional className: string
ChartProps.className
+• data: ChartData
ChartProps.data
+• Optional height: string | number
ChartProps.height
+• Optional legendColors: string[]
ChartProps.legendColors
+• Optional legendPosition: "bottom"
ChartProps.legendPosition
+• Optional options: ChartOptions
ChartProps.options
+• Optional plugins: any[]
ChartProps.plugins
+• Optional redraw: boolean
ChartProps.redraw
+• Optional showChart: boolean
ChartProps.showChart
+• Optional showLegend: boolean
ChartProps.showLegend
+• Optional title: string
ChartProps.title
+• Optional type: ChartKind
ChartProps.type
+• Optional width: string | number
ChartProps.width
+ + + + + + + +Renderer.Component.PodDetailsListProps
+• Optional maxCpu: number
• Optional maxMemory: number
• owner: KubeObject<KubeObjectMetadata, any, any>
• pods: Pod[]
Renderer.Component.SearchInputProps
+InputProps↳ SearchInputProps
• Optional about: string
InputProps.about
+• Optional accept: string
InputProps.accept
+• Optional accessKey: string
InputProps.accessKey
+• Optional alt: string
InputProps.alt
+• Optional aria-activedescendant: string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
+InputProps.aria-activedescendant
+• Optional aria-atomic: Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
+InputProps.aria-atomic
+• Optional aria-autocomplete: "list" | "none" | "inline" | "both"
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.
+InputProps.aria-autocomplete
+• Optional aria-busy: Booleanish
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
+InputProps.aria-busy
+• Optional aria-checked: boolean | "true" | "false" | "mixed"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
+see aria-pressed @see aria-selected.
InputProps.aria-checked
+• Optional aria-colcount: number
Defines the total number of columns in a table, grid, or treegrid.
+see aria-colindex.
InputProps.aria-colcount
+• Optional aria-colindex: number
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
+see aria-colcount @see aria-colspan.
InputProps.aria-colindex
+• Optional aria-colspan: number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
+see aria-colindex @see aria-rowspan.
InputProps.aria-colspan
+• Optional aria-controls: string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
+see aria-owns.
InputProps.aria-controls
+• Optional aria-current: boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date"
Indicates the element that represents the current item within a container or set of related elements.
+InputProps.aria-current
+• Optional aria-describedby: string
Identifies the element (or elements) that describes the object.
+see aria-labelledby
InputProps.aria-describedby
+• Optional aria-details: string
Identifies the element that provides a detailed, extended description for the object.
+see aria-describedby.
InputProps.aria-details
+• Optional aria-disabled: Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
+see aria-hidden @see aria-readonly.
InputProps.aria-disabled
+• Optional aria-dropeffect: "link" | "none" | "copy" | "execute" | "move" | "popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
+deprecated in ARIA 1.1
InputProps.aria-dropeffect
+• Optional aria-errormessage: string
Identifies the element that provides an error message for the object.
+see aria-invalid @see aria-describedby.
InputProps.aria-errormessage
+• Optional aria-expanded: Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
+InputProps.aria-expanded
+• Optional aria-flowto: string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.
+InputProps.aria-flowto
+• Optional aria-grabbed: Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
+deprecated in ARIA 1.1
InputProps.aria-grabbed
+• Optional aria-haspopup: boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
+InputProps.aria-haspopup
+• Optional aria-hidden: Booleanish
Indicates whether the element is exposed to an accessibility API.
+see aria-disabled.
InputProps.aria-hidden
+• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"
Indicates the entered value does not conform to the format expected by the application.
+see aria-errormessage.
InputProps.aria-invalid
+• Optional aria-keyshortcuts: string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
+InputProps.aria-keyshortcuts
+• Optional aria-label: string
Defines a string value that labels the current element.
+see aria-labelledby.
InputProps.aria-label
+• Optional aria-labelledby: string
Identifies the element (or elements) that labels the current element.
+see aria-describedby.
InputProps.aria-labelledby
+• Optional aria-level: number
Defines the hierarchical level of an element within a structure.
+InputProps.aria-level
+• Optional aria-live: "off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
+InputProps.aria-live
+• Optional aria-modal: Booleanish
Indicates whether an element is modal when displayed.
+InputProps.aria-modal
+• Optional aria-multiline: Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
+InputProps.aria-multiline
+• Optional aria-multiselectable: Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
+InputProps.aria-multiselectable
+• Optional aria-orientation: "horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
+InputProps.aria-orientation
+• Optional aria-owns: string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
+see aria-controls.
InputProps.aria-owns
+• Optional aria-placeholder: string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.
+InputProps.aria-placeholder
+• Optional aria-posinset: number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
+see aria-setsize.
InputProps.aria-posinset
+• Optional aria-pressed: boolean | "true" | "false" | "mixed"
Indicates the current "pressed" state of toggle buttons.
+see aria-checked @see aria-selected.
InputProps.aria-pressed
+• Optional aria-readonly: Booleanish
Indicates that the element is not editable, but is otherwise operable.
+see aria-disabled.
InputProps.aria-readonly
+• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
+see aria-atomic.
InputProps.aria-relevant
+• Optional aria-required: Booleanish
Indicates that user input is required on the element before a form may be submitted.
+InputProps.aria-required
+• Optional aria-roledescription: string
Defines a human-readable, author-localized description for the role of an element.
+InputProps.aria-roledescription
+• Optional aria-rowcount: number
Defines the total number of rows in a table, grid, or treegrid.
+see aria-rowindex.
InputProps.aria-rowcount
+• Optional aria-rowindex: number
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
+see aria-rowcount @see aria-rowspan.
InputProps.aria-rowindex
+• Optional aria-rowspan: number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
+see aria-rowindex @see aria-colspan.
InputProps.aria-rowspan
+• Optional aria-selected: Booleanish
Indicates the current "selected" state of various widgets.
+see aria-checked @see aria-pressed.
InputProps.aria-selected
+• Optional aria-setsize: number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
+see aria-posinset.
InputProps.aria-setsize
+• Optional aria-sort: "none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
+InputProps.aria-sort
+• Optional aria-valuemax: number
Defines the maximum allowed value for a range widget.
+InputProps.aria-valuemax
+• Optional aria-valuemin: number
Defines the minimum allowed value for a range widget.
+InputProps.aria-valuemin
+• Optional aria-valuenow: number
Defines the current value for a range widget.
+see aria-valuetext.
InputProps.aria-valuenow
+• Optional aria-valuetext: string
Defines the human readable text alternative of aria-valuenow for a range widget.
+InputProps.aria-valuetext
+• Optional autoCapitalize: string
InputProps.autoCapitalize
+• Optional autoComplete: string
InputProps.autoComplete
+• Optional autoCorrect: string
InputProps.autoCorrect
+• Optional autoFocus: boolean
InputProps.autoFocus
+• Optional autoSave: string
InputProps.autoSave
+• Optional autoSelectOnFocus: boolean
InputProps.autoSelectOnFocus
+• Optional bindGlobalFocusHotkey: boolean
• Optional blurOnEnter: boolean
InputProps.blurOnEnter
+• Optional capture: boolean | "user" | "environment"
InputProps.capture
+• Optional checked: boolean
InputProps.checked
+• Optional children: ReactNode
InputProps.children
+• Optional className: string
InputProps.className
+• Optional color: string
InputProps.color
+• Optional cols: number
InputProps.cols
+• Optional compact: boolean
• Optional contentEditable: Booleanish | "inherit"
InputProps.contentEditable
+• Optional contentRight: ReactNode
InputProps.contentRight
+• Optional contextMenu: string
InputProps.contextMenu
+• Optional crossOrigin: string
InputProps.crossOrigin
+• Optional dangerouslySetInnerHTML: Object
| Name | +Type | +
|---|---|
__html |
+string |
+
InputProps.dangerouslySetInnerHTML
+• Optional datatype: string
InputProps.datatype
+• Optional defaultChecked: boolean
InputProps.defaultChecked
+• Optional defaultValue: string & readonly string[] & string
InputProps.defaultValue
+• Optional dir: string
InputProps.dir
+• Optional dirName: string
InputProps.dirName
+• Optional dirty: boolean
InputProps.dirty
+• Optional disabled: boolean
InputProps.disabled
+• Optional draggable: Booleanish
InputProps.draggable
+• Optional enterKeyHint: "search" | "enter" | "done" | "go" | "next" | "previous" | "send"
InputProps.enterKeyHint
+• Optional form: string
InputProps.form
+• Optional formAction: string
InputProps.formAction
+• Optional formEncType: string
InputProps.formEncType
+• Optional formMethod: string
InputProps.formMethod
+• Optional formNoValidate: boolean
InputProps.formNoValidate
+• Optional formTarget: string
InputProps.formTarget
+• Optional height: string | number
InputProps.height
+• Optional hidden: boolean
InputProps.hidden
+• Optional iconLeft: IconData
InputProps.iconLeft
+• Optional iconRight: IconData
InputProps.iconRight
+• Optional id: string
InputProps.id
+• Optional inlist: any
InputProps.inlist
+• Optional inputMode: "text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
+see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
InputProps.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
InputProps.is
+• Optional itemID: string
InputProps.itemID
+• Optional itemProp: string
InputProps.itemProp
+• Optional itemRef: string
InputProps.itemRef
+• Optional itemScope: boolean
InputProps.itemScope
+• Optional itemType: string
InputProps.itemType
+• Optional lang: string
InputProps.lang
+• Optional list: string
InputProps.list
+• Optional max: string | number
InputProps.max
+• Optional maxLength: number
InputProps.maxLength
+• Optional maxRows: number
InputProps.maxRows
+• Optional min: string | number
InputProps.min
+• Optional minLength: number
InputProps.minLength
+• Optional multiLine: boolean
InputProps.multiLine
+• Optional multiple: boolean
InputProps.multiple
+• Optional name: string
InputProps.name
+• Optional onAbort: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onAbort
+• Optional onAbortCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onAbortCapture
+• Optional onAnimationEnd: AnimationEventHandler<HTMLInputElement> & AnimationEventHandler<HTMLTextAreaElement> & AnimationEventHandler<InputElement>
InputProps.onAnimationEnd
+• Optional onAnimationEndCapture: AnimationEventHandler<HTMLInputElement> & AnimationEventHandler<HTMLTextAreaElement> & AnimationEventHandler<InputElement>
InputProps.onAnimationEndCapture
+• Optional onAnimationIteration: AnimationEventHandler<HTMLInputElement> & AnimationEventHandler<HTMLTextAreaElement> & AnimationEventHandler<InputElement>
InputProps.onAnimationIteration
+• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLInputElement> & AnimationEventHandler<HTMLTextAreaElement> & AnimationEventHandler<InputElement>
InputProps.onAnimationIterationCapture
+• Optional onAnimationStart: AnimationEventHandler<HTMLInputElement> & AnimationEventHandler<HTMLTextAreaElement> & AnimationEventHandler<InputElement>
InputProps.onAnimationStart
+• Optional onAnimationStartCapture: AnimationEventHandler<HTMLInputElement> & AnimationEventHandler<HTMLTextAreaElement> & AnimationEventHandler<InputElement>
InputProps.onAnimationStartCapture
+• Optional onAuxClick: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onAuxClick
+• Optional onAuxClickCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onAuxClickCapture
+• Optional onBeforeInput: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onBeforeInput
+• Optional onBeforeInputCapture: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onBeforeInputCapture
+• Optional onBlur: FocusEventHandler<HTMLInputElement> & FocusEventHandler<HTMLTextAreaElement> & FocusEventHandler<InputElement>
InputProps.onBlur
+• Optional onBlurCapture: FocusEventHandler<HTMLInputElement> & FocusEventHandler<HTMLTextAreaElement> & FocusEventHandler<InputElement>
InputProps.onBlurCapture
+• Optional onCanPlay: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onCanPlay
+• Optional onCanPlayCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onCanPlayCapture
+• Optional onCanPlayThrough: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onCanPlayThrough
+• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onCanPlayThroughCapture
+• Optional onChangeCapture: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onChangeCapture
+• Optional onClick: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onClick
+• Optional onClickCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onClickCapture
+• Optional onCompositionEnd: CompositionEventHandler<HTMLInputElement> & CompositionEventHandler<HTMLTextAreaElement> & CompositionEventHandler<InputElement>
InputProps.onCompositionEnd
+• Optional onCompositionEndCapture: CompositionEventHandler<HTMLInputElement> & CompositionEventHandler<HTMLTextAreaElement> & CompositionEventHandler<InputElement>
InputProps.onCompositionEndCapture
+• Optional onCompositionStart: CompositionEventHandler<HTMLInputElement> & CompositionEventHandler<HTMLTextAreaElement> & CompositionEventHandler<InputElement>
InputProps.onCompositionStart
+• Optional onCompositionStartCapture: CompositionEventHandler<HTMLInputElement> & CompositionEventHandler<HTMLTextAreaElement> & CompositionEventHandler<InputElement>
InputProps.onCompositionStartCapture
+• Optional onCompositionUpdate: CompositionEventHandler<HTMLInputElement> & CompositionEventHandler<HTMLTextAreaElement> & CompositionEventHandler<InputElement>
InputProps.onCompositionUpdate
+• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLInputElement> & CompositionEventHandler<HTMLTextAreaElement> & CompositionEventHandler<InputElement>
InputProps.onCompositionUpdateCapture
+• Optional onContextMenu: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onContextMenu
+• Optional onContextMenuCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onContextMenuCapture
+• Optional onCopy: ClipboardEventHandler<HTMLInputElement> & ClipboardEventHandler<HTMLTextAreaElement> & ClipboardEventHandler<InputElement>
InputProps.onCopy
+• Optional onCopyCapture: ClipboardEventHandler<HTMLInputElement> & ClipboardEventHandler<HTMLTextAreaElement> & ClipboardEventHandler<InputElement>
InputProps.onCopyCapture
+• Optional onCut: ClipboardEventHandler<HTMLInputElement> & ClipboardEventHandler<HTMLTextAreaElement> & ClipboardEventHandler<InputElement>
InputProps.onCut
+• Optional onCutCapture: ClipboardEventHandler<HTMLInputElement> & ClipboardEventHandler<HTMLTextAreaElement> & ClipboardEventHandler<InputElement>
InputProps.onCutCapture
+• Optional onDoubleClick: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onDoubleClick
+• Optional onDoubleClickCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onDoubleClickCapture
+• Optional onDrag: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDrag
+• Optional onDragCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragCapture
+• Optional onDragEnd: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragEnd
+• Optional onDragEndCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragEndCapture
+• Optional onDragEnter: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragEnter
+• Optional onDragEnterCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragEnterCapture
+• Optional onDragExit: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragExit
+• Optional onDragExitCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragExitCapture
+• Optional onDragLeave: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragLeave
+• Optional onDragLeaveCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragLeaveCapture
+• Optional onDragOver: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragOver
+• Optional onDragOverCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragOverCapture
+• Optional onDragStart: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragStart
+• Optional onDragStartCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDragStartCapture
+• Optional onDrop: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDrop
+• Optional onDropCapture: DragEventHandler<HTMLInputElement> & DragEventHandler<HTMLTextAreaElement> & DragEventHandler<InputElement>
InputProps.onDropCapture
+• Optional onDurationChange: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onDurationChange
+• Optional onDurationChangeCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onDurationChangeCapture
+• Optional onEmptied: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onEmptied
+• Optional onEmptiedCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onEmptiedCapture
+• Optional onEncrypted: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onEncrypted
+• Optional onEncryptedCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onEncryptedCapture
+• Optional onEnded: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onEnded
+• Optional onEndedCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onEndedCapture
+• Optional onError: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onError
+• Optional onErrorCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onErrorCapture
+• Optional onFocus: FocusEventHandler<HTMLInputElement> & FocusEventHandler<HTMLTextAreaElement> & FocusEventHandler<InputElement>
InputProps.onFocus
+• Optional onFocusCapture: FocusEventHandler<HTMLInputElement> & FocusEventHandler<HTMLTextAreaElement> & FocusEventHandler<InputElement>
InputProps.onFocusCapture
+• Optional onGotPointerCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onGotPointerCapture
+• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onGotPointerCaptureCapture
+• Optional onInput: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onInput
+• Optional onInputCapture: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onInputCapture
+• Optional onInvalid: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onInvalid
+• Optional onInvalidCapture: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onInvalidCapture
+• Optional onKeyDown: KeyboardEventHandler<HTMLInputElement> & KeyboardEventHandler<HTMLTextAreaElement> & KeyboardEventHandler<InputElement>
InputProps.onKeyDown
+• Optional onKeyDownCapture: KeyboardEventHandler<HTMLInputElement> & KeyboardEventHandler<HTMLTextAreaElement> & KeyboardEventHandler<InputElement>
InputProps.onKeyDownCapture
+• Optional onKeyPress: KeyboardEventHandler<HTMLInputElement> & KeyboardEventHandler<HTMLTextAreaElement> & KeyboardEventHandler<InputElement>
InputProps.onKeyPress
+• Optional onKeyPressCapture: KeyboardEventHandler<HTMLInputElement> & KeyboardEventHandler<HTMLTextAreaElement> & KeyboardEventHandler<InputElement>
InputProps.onKeyPressCapture
+• Optional onKeyUp: KeyboardEventHandler<HTMLInputElement> & KeyboardEventHandler<HTMLTextAreaElement> & KeyboardEventHandler<InputElement>
InputProps.onKeyUp
+• Optional onKeyUpCapture: KeyboardEventHandler<HTMLInputElement> & KeyboardEventHandler<HTMLTextAreaElement> & KeyboardEventHandler<InputElement>
InputProps.onKeyUpCapture
+• Optional onLoad: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoad
+• Optional onLoadCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoadCapture
+• Optional onLoadStart: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoadStart
+• Optional onLoadStartCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoadStartCapture
+• Optional onLoadedData: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoadedData
+• Optional onLoadedDataCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoadedDataCapture
+• Optional onLoadedMetadata: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoadedMetadata
+• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onLoadedMetadataCapture
+• Optional onLostPointerCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onLostPointerCapture
+• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onLostPointerCaptureCapture
+• Optional onMouseDown: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseDown
+• Optional onMouseDownCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseDownCapture
+• Optional onMouseEnter: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseEnter
+• Optional onMouseLeave: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseLeave
+• Optional onMouseMove: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseMove
+• Optional onMouseMoveCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseMoveCapture
+• Optional onMouseOut: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseOut
+• Optional onMouseOutCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseOutCapture
+• Optional onMouseOver: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseOver
+• Optional onMouseOverCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseOverCapture
+• Optional onMouseUp: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseUp
+• Optional onMouseUpCapture: MouseEventHandler<HTMLInputElement> & MouseEventHandler<HTMLTextAreaElement> & MouseEventHandler<InputElement>
InputProps.onMouseUpCapture
+• Optional onPaste: ClipboardEventHandler<HTMLInputElement> & ClipboardEventHandler<HTMLTextAreaElement> & ClipboardEventHandler<InputElement>
InputProps.onPaste
+• Optional onPasteCapture: ClipboardEventHandler<HTMLInputElement> & ClipboardEventHandler<HTMLTextAreaElement> & ClipboardEventHandler<InputElement>
InputProps.onPasteCapture
+• Optional onPause: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onPause
+• Optional onPauseCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onPauseCapture
+• Optional onPlay: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onPlay
+• Optional onPlayCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onPlayCapture
+• Optional onPlaying: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onPlaying
+• Optional onPlayingCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onPlayingCapture
+• Optional onPointerCancel: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerCancel
+• Optional onPointerCancelCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerCancelCapture
+• Optional onPointerDown: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerDown
+• Optional onPointerDownCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerDownCapture
+• Optional onPointerEnter: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerEnter
+• Optional onPointerEnterCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerEnterCapture
+• Optional onPointerLeave: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerLeave
+• Optional onPointerLeaveCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerLeaveCapture
+• Optional onPointerMove: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerMove
+• Optional onPointerMoveCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerMoveCapture
+• Optional onPointerOut: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerOut
+• Optional onPointerOutCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerOutCapture
+• Optional onPointerOver: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerOver
+• Optional onPointerOverCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerOverCapture
+• Optional onPointerUp: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerUp
+• Optional onPointerUpCapture: PointerEventHandler<HTMLInputElement> & PointerEventHandler<HTMLTextAreaElement> & PointerEventHandler<InputElement>
InputProps.onPointerUpCapture
+• Optional onProgress: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onProgress
+• Optional onProgressCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onProgressCapture
+• Optional onRateChange: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onRateChange
+• Optional onRateChangeCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onRateChangeCapture
+• Optional onReset: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onReset
+• Optional onResetCapture: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onResetCapture
+• Optional onScroll: UIEventHandler<HTMLInputElement> & UIEventHandler<HTMLTextAreaElement> & UIEventHandler<InputElement>
InputProps.onScroll
+• Optional onScrollCapture: UIEventHandler<HTMLInputElement> & UIEventHandler<HTMLTextAreaElement> & UIEventHandler<InputElement>
InputProps.onScrollCapture
+• Optional onSeeked: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSeeked
+• Optional onSeekedCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSeekedCapture
+• Optional onSeeking: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSeeking
+• Optional onSeekingCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSeekingCapture
+• Optional onSelect: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSelect
+• Optional onSelectCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSelectCapture
+• Optional onStalled: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onStalled
+• Optional onStalledCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onStalledCapture
+• Optional onSubmitCapture: FormEventHandler<HTMLInputElement> & FormEventHandler<HTMLTextAreaElement> & FormEventHandler<InputElement>
InputProps.onSubmitCapture
+• Optional onSuspend: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSuspend
+• Optional onSuspendCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onSuspendCapture
+• Optional onTimeUpdate: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onTimeUpdate
+• Optional onTimeUpdateCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onTimeUpdateCapture
+• Optional onTouchCancel: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchCancel
+• Optional onTouchCancelCapture: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchCancelCapture
+• Optional onTouchEnd: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchEnd
+• Optional onTouchEndCapture: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchEndCapture
+• Optional onTouchMove: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchMove
+• Optional onTouchMoveCapture: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchMoveCapture
+• Optional onTouchStart: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchStart
+• Optional onTouchStartCapture: TouchEventHandler<HTMLInputElement> & TouchEventHandler<HTMLTextAreaElement> & TouchEventHandler<InputElement>
InputProps.onTouchStartCapture
+• Optional onTransitionEnd: TransitionEventHandler<HTMLInputElement> & TransitionEventHandler<HTMLTextAreaElement> & TransitionEventHandler<InputElement>
InputProps.onTransitionEnd
+• Optional onTransitionEndCapture: TransitionEventHandler<HTMLInputElement> & TransitionEventHandler<HTMLTextAreaElement> & TransitionEventHandler<InputElement>
InputProps.onTransitionEndCapture
+• Optional onVolumeChange: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onVolumeChange
+• Optional onVolumeChangeCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onVolumeChangeCapture
+• Optional onWaiting: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onWaiting
+• Optional onWaitingCapture: ReactEventHandler<HTMLInputElement> & ReactEventHandler<HTMLTextAreaElement> & ReactEventHandler<InputElement>
InputProps.onWaitingCapture
+• Optional onWheel: WheelEventHandler<HTMLInputElement> & WheelEventHandler<HTMLTextAreaElement> & WheelEventHandler<InputElement>
InputProps.onWheel
+• Optional onWheelCapture: WheelEventHandler<HTMLInputElement> & WheelEventHandler<HTMLTextAreaElement> & WheelEventHandler<InputElement>
InputProps.onWheelCapture
+• Optional pattern: string
InputProps.pattern
+• Optional placeholder: string
InputProps.placeholder
+• Optional prefix: string
InputProps.prefix
+• Optional property: string
InputProps.property
+• Optional radioGroup: string
InputProps.radioGroup
+• Optional readOnly: boolean
InputProps.readOnly
+• Optional required: boolean
InputProps.required
+• Optional resource: string
InputProps.resource
+• Optional results: number
InputProps.results
+• Optional role: AriaRole
InputProps.role
+• Optional rows: number
InputProps.rows
+• Optional security: string
InputProps.security
+• Optional showClearIcon: boolean
• Optional showErrorsAsTooltip: boolean | Omit<TooltipProps, "targetId">
InputProps.showErrorsAsTooltip
+• Optional showValidationLine: boolean
InputProps.showValidationLine
+• Optional size: number
InputProps.size
+• Optional slot: string
InputProps.slot
+• Optional spellCheck: Booleanish
InputProps.spellCheck
+• Optional src: string
InputProps.src
+• Optional step: string | number
InputProps.step
+• Optional style: CSSProperties
InputProps.style
+• Optional suppressContentEditableWarning: boolean
InputProps.suppressContentEditableWarning
+• Optional suppressHydrationWarning: boolean
InputProps.suppressHydrationWarning
+• Optional tabIndex: number
InputProps.tabIndex
+• Optional theme: "round" | "round-black"
InputProps.theme
+• Optional title: string
InputProps.title
+• Optional translate: "yes" | "no"
InputProps.translate
+• Optional trim: boolean
InputProps.trim
+• Optional type: HTMLInputTypeAttribute
InputProps.type
+• Optional typeof: string
InputProps.typeof
+• Optional unselectable: "on" | "off"
InputProps.unselectable
+• Optional validators: InputValidator | InputValidator[]
InputProps.validators
+• Optional value: string & readonly string[] & string
InputProps.value
+• Optional vocab: string
InputProps.vocab
+• Optional width: string | number
InputProps.width
+• Optional wrap: string
InputProps.wrap
+▸ Optional onChange(value, evt): void
| Name | +Type | +
|---|---|
value |
+string |
+
evt |
+ChangeEvent<InputElement> |
+
void
InputProps.onChange
+▸ Optional onClear(): void
void
▸ Optional onSubmit(value, evt): void
| Name | +Type | +
|---|---|
value |
+string |
+
evt |
+KeyboardEvent<InputElement> |
+
void
InputProps.onSubmit
+ + + + + + + +↳ SelectProps
Renderer.Component.SwitchProps
+Omit<HTMLProps<HTMLInputElement>, "onChange">↳ SwitchProps
• Optional about: string
Omit.about
+• Optional accept: string
Omit.accept
+• Optional acceptCharset: string
Omit.acceptCharset
+• Optional accessKey: string
Omit.accessKey
+• Optional action: string
Omit.action
+• Optional allowFullScreen: boolean
Omit.allowFullScreen
+• Optional allowTransparency: boolean
Omit.allowTransparency
+• Optional alt: string
Omit.alt
+• Optional aria-activedescendant: string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
+Omit.aria-activedescendant
+• Optional aria-atomic: Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
+Omit.aria-atomic
+• Optional aria-autocomplete: "list" | "none" | "inline" | "both"
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.
+Omit.aria-autocomplete
+• Optional aria-busy: Booleanish
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
+Omit.aria-busy
+• Optional aria-checked: boolean | "true" | "false" | "mixed"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
+see aria-pressed @see aria-selected.
Omit.aria-checked
+• Optional aria-colcount: number
Defines the total number of columns in a table, grid, or treegrid.
+see aria-colindex.
Omit.aria-colcount
+• Optional aria-colindex: number
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
+see aria-colcount @see aria-colspan.
Omit.aria-colindex
+• Optional aria-colspan: number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
+see aria-colindex @see aria-rowspan.
Omit.aria-colspan
+• Optional aria-controls: string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
+see aria-owns.
Omit.aria-controls
+• Optional aria-current: boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date"
Indicates the element that represents the current item within a container or set of related elements.
+Omit.aria-current
+• Optional aria-describedby: string
Identifies the element (or elements) that describes the object.
+see aria-labelledby
Omit.aria-describedby
+• Optional aria-details: string
Identifies the element that provides a detailed, extended description for the object.
+see aria-describedby.
Omit.aria-details
+• Optional aria-disabled: Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
+see aria-hidden @see aria-readonly.
Omit.aria-disabled
+• Optional aria-dropeffect: "link" | "none" | "copy" | "execute" | "move" | "popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
+deprecated in ARIA 1.1
Omit.aria-dropeffect
+• Optional aria-errormessage: string
Identifies the element that provides an error message for the object.
+see aria-invalid @see aria-describedby.
Omit.aria-errormessage
+• Optional aria-expanded: Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
+Omit.aria-expanded
+• Optional aria-flowto: string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.
+Omit.aria-flowto
+• Optional aria-grabbed: Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
+deprecated in ARIA 1.1
Omit.aria-grabbed
+• Optional aria-haspopup: boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
+Omit.aria-haspopup
+• Optional aria-hidden: Booleanish
Indicates whether the element is exposed to an accessibility API.
+see aria-disabled.
Omit.aria-hidden
+• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"
Indicates the entered value does not conform to the format expected by the application.
+see aria-errormessage.
Omit.aria-invalid
+• Optional aria-keyshortcuts: string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
+Omit.aria-keyshortcuts
+• Optional aria-label: string
Defines a string value that labels the current element.
+see aria-labelledby.
Omit.aria-label
+• Optional aria-labelledby: string
Identifies the element (or elements) that labels the current element.
+see aria-describedby.
Omit.aria-labelledby
+• Optional aria-level: number
Defines the hierarchical level of an element within a structure.
+Omit.aria-level
+• Optional aria-live: "off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
+Omit.aria-live
+• Optional aria-modal: Booleanish
Indicates whether an element is modal when displayed.
+Omit.aria-modal
+• Optional aria-multiline: Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
+Omit.aria-multiline
+• Optional aria-multiselectable: Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
+Omit.aria-multiselectable
+• Optional aria-orientation: "horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
+Omit.aria-orientation
+• Optional aria-owns: string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
+see aria-controls.
Omit.aria-owns
+• Optional aria-placeholder: string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.
+Omit.aria-placeholder
+• Optional aria-posinset: number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
+see aria-setsize.
Omit.aria-posinset
+• Optional aria-pressed: boolean | "true" | "false" | "mixed"
Indicates the current "pressed" state of toggle buttons.
+see aria-checked @see aria-selected.
Omit.aria-pressed
+• Optional aria-readonly: Booleanish
Indicates that the element is not editable, but is otherwise operable.
+see aria-disabled.
Omit.aria-readonly
+• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
+see aria-atomic.
Omit.aria-relevant
+• Optional aria-required: Booleanish
Indicates that user input is required on the element before a form may be submitted.
+Omit.aria-required
+• Optional aria-roledescription: string
Defines a human-readable, author-localized description for the role of an element.
+Omit.aria-roledescription
+• Optional aria-rowcount: number
Defines the total number of rows in a table, grid, or treegrid.
+see aria-rowindex.
Omit.aria-rowcount
+• Optional aria-rowindex: number
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
+see aria-rowcount @see aria-rowspan.
Omit.aria-rowindex
+• Optional aria-rowspan: number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
+see aria-rowindex @see aria-colspan.
Omit.aria-rowspan
+• Optional aria-selected: Booleanish
Indicates the current "selected" state of various widgets.
+see aria-checked @see aria-pressed.
Omit.aria-selected
+• Optional aria-setsize: number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
+see aria-posinset.
Omit.aria-setsize
+• Optional aria-sort: "none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
+Omit.aria-sort
+• Optional aria-valuemax: number
Defines the maximum allowed value for a range widget.
+Omit.aria-valuemax
+• Optional aria-valuemin: number
Defines the minimum allowed value for a range widget.
+Omit.aria-valuemin
+• Optional aria-valuenow: number
Defines the current value for a range widget.
+see aria-valuetext.
Omit.aria-valuenow
+• Optional aria-valuetext: string
Defines the human readable text alternative of aria-valuenow for a range widget.
+Omit.aria-valuetext
+• Optional as: string
Omit.as
+• Optional async: boolean
Omit.async
+• Optional autoCapitalize: string
Omit.autoCapitalize
+• Optional autoComplete: string
Omit.autoComplete
+• Optional autoCorrect: string
Omit.autoCorrect
+• Optional autoFocus: boolean
Omit.autoFocus
+• Optional autoPlay: boolean
Omit.autoPlay
+• Optional autoSave: string
Omit.autoSave
+• Optional capture: boolean | "user" | "environment"
Omit.capture
+• Optional cellPadding: string | number
Omit.cellPadding
+• Optional cellSpacing: string | number
Omit.cellSpacing
+• Optional challenge: string
Omit.challenge
+• Optional charSet: string
Omit.charSet
+• Optional checked: boolean
Omit.checked
+• Optional children: ReactNode
Omit.children
+• Optional cite: string
Omit.cite
+• Optional classID: string
Omit.classID
+• Optional className: string
Omit.className
+• Optional colSpan: number
Omit.colSpan
+• Optional color: string
Omit.color
+• Optional cols: number
Omit.cols
+• Optional content: string
Omit.content
+• Optional contentEditable: Booleanish | "inherit"
Omit.contentEditable
+• Optional contextMenu: string
Omit.contextMenu
+• Optional controls: boolean
Omit.controls
+• Optional coords: string
Omit.coords
+• Optional crossOrigin: string
Omit.crossOrigin
+• Optional dangerouslySetInnerHTML: Object
| Name | +Type | +
|---|---|
__html |
+string |
+
Omit.dangerouslySetInnerHTML
+• Optional data: string
Omit.data
+• Optional datatype: string
Omit.datatype
+• Optional dateTime: string
Omit.dateTime
+• Optional default: boolean
Omit.default
+• Optional defaultChecked: boolean
Omit.defaultChecked
+• Optional defaultValue: string | number | readonly string[]
Omit.defaultValue
+• Optional defer: boolean
Omit.defer
+• Optional dir: string
Omit.dir
+• Optional disabled: boolean
Omit.disabled
+• Optional download: any
Omit.download
+• Optional draggable: Booleanish
Omit.draggable
+• Optional encType: string
Omit.encType
+• Optional form: string
Omit.form
+• Optional formAction: string
Omit.formAction
+• Optional formEncType: string
Omit.formEncType
+• Optional formMethod: string
Omit.formMethod
+• Optional formNoValidate: boolean
Omit.formNoValidate
+• Optional formTarget: string
Omit.formTarget
+• Optional frameBorder: string | number
Omit.frameBorder
+• Optional headers: string
Omit.headers
+• Optional height: string | number
Omit.height
+• Optional hidden: boolean
Omit.hidden
+• Optional high: number
Omit.high
+• Optional href: string
Omit.href
+• Optional hrefLang: string
Omit.hrefLang
+• Optional htmlFor: string
Omit.htmlFor
+• Optional httpEquiv: string
Omit.httpEquiv
+• Optional id: string
Omit.id
+• Optional inlist: any
Omit.inlist
+• Optional inputMode: "text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
+see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
Omit.inputMode
+• Optional integrity: string
Omit.integrity
+• 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: Key
Omit.key
+• Optional keyParams: string
Omit.keyParams
+• Optional keyType: string
Omit.keyType
+• Optional kind: string
Omit.kind
+• Optional label: string
Omit.label
+• Optional lang: string
Omit.lang
+• Optional list: string
Omit.list
+• Optional loop: boolean
Omit.loop
+• Optional low: number
Omit.low
+• Optional manifest: string
Omit.manifest
+• Optional marginHeight: number
Omit.marginHeight
+• Optional marginWidth: number
Omit.marginWidth
+• Optional max: string | number
Omit.max
+• Optional maxLength: number
Omit.maxLength
+• Optional media: string
Omit.media
+• Optional mediaGroup: string
Omit.mediaGroup
+• Optional method: string
Omit.method
+• Optional min: string | number
Omit.min
+• Optional minLength: number
Omit.minLength
+• Optional multiple: boolean
Omit.multiple
+• Optional muted: boolean
Omit.muted
+• Optional name: string
Omit.name
+• Optional noValidate: boolean
Omit.noValidate
+• Optional nonce: string
Omit.nonce
+• Optional onAbort: ReactEventHandler<HTMLInputElement>
Omit.onAbort
+• Optional onAbortCapture: ReactEventHandler<HTMLInputElement>
Omit.onAbortCapture
+• Optional onAnimationEnd: AnimationEventHandler<HTMLInputElement>
Omit.onAnimationEnd
+• Optional onAnimationEndCapture: AnimationEventHandler<HTMLInputElement>
Omit.onAnimationEndCapture
+• Optional onAnimationIteration: AnimationEventHandler<HTMLInputElement>
Omit.onAnimationIteration
+• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLInputElement>
Omit.onAnimationIterationCapture
+• Optional onAnimationStart: AnimationEventHandler<HTMLInputElement>
Omit.onAnimationStart
+• Optional onAnimationStartCapture: AnimationEventHandler<HTMLInputElement>
Omit.onAnimationStartCapture
+• Optional onAuxClick: MouseEventHandler<HTMLInputElement>
Omit.onAuxClick
+• Optional onAuxClickCapture: MouseEventHandler<HTMLInputElement>
Omit.onAuxClickCapture
+• Optional onBeforeInput: FormEventHandler<HTMLInputElement>
Omit.onBeforeInput
+• Optional onBeforeInputCapture: FormEventHandler<HTMLInputElement>
Omit.onBeforeInputCapture
+• Optional onBlur: FocusEventHandler<HTMLInputElement>
Omit.onBlur
+• Optional onBlurCapture: FocusEventHandler<HTMLInputElement>
Omit.onBlurCapture
+• Optional onCanPlay: ReactEventHandler<HTMLInputElement>
Omit.onCanPlay
+• Optional onCanPlayCapture: ReactEventHandler<HTMLInputElement>
Omit.onCanPlayCapture
+• Optional onCanPlayThrough: ReactEventHandler<HTMLInputElement>
Omit.onCanPlayThrough
+• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLInputElement>
Omit.onCanPlayThroughCapture
+• Optional onChangeCapture: FormEventHandler<HTMLInputElement>
Omit.onChangeCapture
+• Optional onClick: MouseEventHandler<HTMLInputElement>
Omit.onClick
+• Optional onClickCapture: MouseEventHandler<HTMLInputElement>
Omit.onClickCapture
+• Optional onCompositionEnd: CompositionEventHandler<HTMLInputElement>
Omit.onCompositionEnd
+• Optional onCompositionEndCapture: CompositionEventHandler<HTMLInputElement>
Omit.onCompositionEndCapture
+• Optional onCompositionStart: CompositionEventHandler<HTMLInputElement>
Omit.onCompositionStart
+• Optional onCompositionStartCapture: CompositionEventHandler<HTMLInputElement>
Omit.onCompositionStartCapture
+• Optional onCompositionUpdate: CompositionEventHandler<HTMLInputElement>
Omit.onCompositionUpdate
+• Optional onCompositionUpdateCapture: CompositionEventHandler<HTMLInputElement>
Omit.onCompositionUpdateCapture
+• Optional onContextMenu: MouseEventHandler<HTMLInputElement>
Omit.onContextMenu
+• Optional onContextMenuCapture: MouseEventHandler<HTMLInputElement>
Omit.onContextMenuCapture
+• Optional onCopy: ClipboardEventHandler<HTMLInputElement>
Omit.onCopy
+• Optional onCopyCapture: ClipboardEventHandler<HTMLInputElement>
Omit.onCopyCapture
+• Optional onCut: ClipboardEventHandler<HTMLInputElement>
Omit.onCut
+• Optional onCutCapture: ClipboardEventHandler<HTMLInputElement>
Omit.onCutCapture
+• Optional onDoubleClick: MouseEventHandler<HTMLInputElement>
Omit.onDoubleClick
+• Optional onDoubleClickCapture: MouseEventHandler<HTMLInputElement>
Omit.onDoubleClickCapture
+• Optional onDrag: DragEventHandler<HTMLInputElement>
Omit.onDrag
+• Optional onDragCapture: DragEventHandler<HTMLInputElement>
Omit.onDragCapture
+• Optional onDragEnd: DragEventHandler<HTMLInputElement>
Omit.onDragEnd
+• Optional onDragEndCapture: DragEventHandler<HTMLInputElement>
Omit.onDragEndCapture
+• Optional onDragEnter: DragEventHandler<HTMLInputElement>
Omit.onDragEnter
+• Optional onDragEnterCapture: DragEventHandler<HTMLInputElement>
Omit.onDragEnterCapture
+• Optional onDragExit: DragEventHandler<HTMLInputElement>
Omit.onDragExit
+• Optional onDragExitCapture: DragEventHandler<HTMLInputElement>
Omit.onDragExitCapture
+• Optional onDragLeave: DragEventHandler<HTMLInputElement>
Omit.onDragLeave
+• Optional onDragLeaveCapture: DragEventHandler<HTMLInputElement>
Omit.onDragLeaveCapture
+• Optional onDragOver: DragEventHandler<HTMLInputElement>
Omit.onDragOver
+• Optional onDragOverCapture: DragEventHandler<HTMLInputElement>
Omit.onDragOverCapture
+• Optional onDragStart: DragEventHandler<HTMLInputElement>
Omit.onDragStart
+• Optional onDragStartCapture: DragEventHandler<HTMLInputElement>
Omit.onDragStartCapture
+• Optional onDrop: DragEventHandler<HTMLInputElement>
Omit.onDrop
+• Optional onDropCapture: DragEventHandler<HTMLInputElement>
Omit.onDropCapture
+• Optional onDurationChange: ReactEventHandler<HTMLInputElement>
Omit.onDurationChange
+• Optional onDurationChangeCapture: ReactEventHandler<HTMLInputElement>
Omit.onDurationChangeCapture
+• Optional onEmptied: ReactEventHandler<HTMLInputElement>
Omit.onEmptied
+• Optional onEmptiedCapture: ReactEventHandler<HTMLInputElement>
Omit.onEmptiedCapture
+• Optional onEncrypted: ReactEventHandler<HTMLInputElement>
Omit.onEncrypted
+• Optional onEncryptedCapture: ReactEventHandler<HTMLInputElement>
Omit.onEncryptedCapture
+• Optional onEnded: ReactEventHandler<HTMLInputElement>
Omit.onEnded
+• Optional onEndedCapture: ReactEventHandler<HTMLInputElement>
Omit.onEndedCapture
+• Optional onError: ReactEventHandler<HTMLInputElement>
Omit.onError
+• Optional onErrorCapture: ReactEventHandler<HTMLInputElement>
Omit.onErrorCapture
+• Optional onFocus: FocusEventHandler<HTMLInputElement>
Omit.onFocus
+• Optional onFocusCapture: FocusEventHandler<HTMLInputElement>
Omit.onFocusCapture
+• Optional onGotPointerCapture: PointerEventHandler<HTMLInputElement>
Omit.onGotPointerCapture
+• Optional onGotPointerCaptureCapture: PointerEventHandler<HTMLInputElement>
Omit.onGotPointerCaptureCapture
+• Optional onInput: FormEventHandler<HTMLInputElement>
Omit.onInput
+• Optional onInputCapture: FormEventHandler<HTMLInputElement>
Omit.onInputCapture
+• Optional onInvalid: FormEventHandler<HTMLInputElement>
Omit.onInvalid
+• Optional onInvalidCapture: FormEventHandler<HTMLInputElement>
Omit.onInvalidCapture
+• Optional onKeyDown: KeyboardEventHandler<HTMLInputElement>
Omit.onKeyDown
+• Optional onKeyDownCapture: KeyboardEventHandler<HTMLInputElement>
Omit.onKeyDownCapture
+• Optional onKeyPress: KeyboardEventHandler<HTMLInputElement>
Omit.onKeyPress
+• Optional onKeyPressCapture: KeyboardEventHandler<HTMLInputElement>
Omit.onKeyPressCapture
+• Optional onKeyUp: KeyboardEventHandler<HTMLInputElement>
Omit.onKeyUp
+• Optional onKeyUpCapture: KeyboardEventHandler<HTMLInputElement>
Omit.onKeyUpCapture
+• Optional onLoad: ReactEventHandler<HTMLInputElement>
Omit.onLoad
+• Optional onLoadCapture: ReactEventHandler<HTMLInputElement>
Omit.onLoadCapture
+• Optional onLoadStart: ReactEventHandler<HTMLInputElement>
Omit.onLoadStart
+• Optional onLoadStartCapture: ReactEventHandler<HTMLInputElement>
Omit.onLoadStartCapture
+• Optional onLoadedData: ReactEventHandler<HTMLInputElement>
Omit.onLoadedData
+• Optional onLoadedDataCapture: ReactEventHandler<HTMLInputElement>
Omit.onLoadedDataCapture
+• Optional onLoadedMetadata: ReactEventHandler<HTMLInputElement>
Omit.onLoadedMetadata
+• Optional onLoadedMetadataCapture: ReactEventHandler<HTMLInputElement>
Omit.onLoadedMetadataCapture
+• Optional onLostPointerCapture: PointerEventHandler<HTMLInputElement>
Omit.onLostPointerCapture
+• Optional onLostPointerCaptureCapture: PointerEventHandler<HTMLInputElement>
Omit.onLostPointerCaptureCapture
+• Optional onMouseDown: MouseEventHandler<HTMLInputElement>
Omit.onMouseDown
+• Optional onMouseDownCapture: MouseEventHandler<HTMLInputElement>
Omit.onMouseDownCapture
+• Optional onMouseEnter: MouseEventHandler<HTMLInputElement>
Omit.onMouseEnter
+• Optional onMouseLeave: MouseEventHandler<HTMLInputElement>
Omit.onMouseLeave
+• Optional onMouseMove: MouseEventHandler<HTMLInputElement>
Omit.onMouseMove
+• Optional onMouseMoveCapture: MouseEventHandler<HTMLInputElement>
Omit.onMouseMoveCapture
+• Optional onMouseOut: MouseEventHandler<HTMLInputElement>
Omit.onMouseOut
+• Optional onMouseOutCapture: MouseEventHandler<HTMLInputElement>
Omit.onMouseOutCapture
+• Optional onMouseOver: MouseEventHandler<HTMLInputElement>
Omit.onMouseOver
+• Optional onMouseOverCapture: MouseEventHandler<HTMLInputElement>
Omit.onMouseOverCapture
+• Optional onMouseUp: MouseEventHandler<HTMLInputElement>
Omit.onMouseUp
+• Optional onMouseUpCapture: MouseEventHandler<HTMLInputElement>
Omit.onMouseUpCapture
+• Optional onPaste: ClipboardEventHandler<HTMLInputElement>
Omit.onPaste
+• Optional onPasteCapture: ClipboardEventHandler<HTMLInputElement>
Omit.onPasteCapture
+• Optional onPause: ReactEventHandler<HTMLInputElement>
Omit.onPause
+• Optional onPauseCapture: ReactEventHandler<HTMLInputElement>
Omit.onPauseCapture
+• Optional onPlay: ReactEventHandler<HTMLInputElement>
Omit.onPlay
+• Optional onPlayCapture: ReactEventHandler<HTMLInputElement>
Omit.onPlayCapture
+• Optional onPlaying: ReactEventHandler<HTMLInputElement>
Omit.onPlaying
+• Optional onPlayingCapture: ReactEventHandler<HTMLInputElement>
Omit.onPlayingCapture
+• Optional onPointerCancel: PointerEventHandler<HTMLInputElement>
Omit.onPointerCancel
+• Optional onPointerCancelCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerCancelCapture
+• Optional onPointerDown: PointerEventHandler<HTMLInputElement>
Omit.onPointerDown
+• Optional onPointerDownCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerDownCapture
+• Optional onPointerEnter: PointerEventHandler<HTMLInputElement>
Omit.onPointerEnter
+• Optional onPointerEnterCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerEnterCapture
+• Optional onPointerLeave: PointerEventHandler<HTMLInputElement>
Omit.onPointerLeave
+• Optional onPointerLeaveCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerLeaveCapture
+• Optional onPointerMove: PointerEventHandler<HTMLInputElement>
Omit.onPointerMove
+• Optional onPointerMoveCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerMoveCapture
+• Optional onPointerOut: PointerEventHandler<HTMLInputElement>
Omit.onPointerOut
+• Optional onPointerOutCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerOutCapture
+• Optional onPointerOver: PointerEventHandler<HTMLInputElement>
Omit.onPointerOver
+• Optional onPointerOverCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerOverCapture
+• Optional onPointerUp: PointerEventHandler<HTMLInputElement>
Omit.onPointerUp
+• Optional onPointerUpCapture: PointerEventHandler<HTMLInputElement>
Omit.onPointerUpCapture
+• Optional onProgress: ReactEventHandler<HTMLInputElement>
Omit.onProgress
+• Optional onProgressCapture: ReactEventHandler<HTMLInputElement>
Omit.onProgressCapture
+• Optional onRateChange: ReactEventHandler<HTMLInputElement>
Omit.onRateChange
+• Optional onRateChangeCapture: ReactEventHandler<HTMLInputElement>
Omit.onRateChangeCapture
+• Optional onReset: FormEventHandler<HTMLInputElement>
Omit.onReset
+• Optional onResetCapture: FormEventHandler<HTMLInputElement>
Omit.onResetCapture
+• Optional onScroll: UIEventHandler<HTMLInputElement>
Omit.onScroll
+• Optional onScrollCapture: UIEventHandler<HTMLInputElement>
Omit.onScrollCapture
+• Optional onSeeked: ReactEventHandler<HTMLInputElement>
Omit.onSeeked
+• Optional onSeekedCapture: ReactEventHandler<HTMLInputElement>
Omit.onSeekedCapture
+• Optional onSeeking: ReactEventHandler<HTMLInputElement>
Omit.onSeeking
+• Optional onSeekingCapture: ReactEventHandler<HTMLInputElement>
Omit.onSeekingCapture
+• Optional onSelect: ReactEventHandler<HTMLInputElement>
Omit.onSelect
+• Optional onSelectCapture: ReactEventHandler<HTMLInputElement>
Omit.onSelectCapture
+• Optional onStalled: ReactEventHandler<HTMLInputElement>
Omit.onStalled
+• Optional onStalledCapture: ReactEventHandler<HTMLInputElement>
Omit.onStalledCapture
+• Optional onSubmit: FormEventHandler<HTMLInputElement>
Omit.onSubmit
+• Optional onSubmitCapture: FormEventHandler<HTMLInputElement>
Omit.onSubmitCapture
+• Optional onSuspend: ReactEventHandler<HTMLInputElement>
Omit.onSuspend
+• Optional onSuspendCapture: ReactEventHandler<HTMLInputElement>
Omit.onSuspendCapture
+• Optional onTimeUpdate: ReactEventHandler<HTMLInputElement>
Omit.onTimeUpdate
+• Optional onTimeUpdateCapture: ReactEventHandler<HTMLInputElement>
Omit.onTimeUpdateCapture
+• Optional onTouchCancel: TouchEventHandler<HTMLInputElement>
Omit.onTouchCancel
+• Optional onTouchCancelCapture: TouchEventHandler<HTMLInputElement>
Omit.onTouchCancelCapture
+• Optional onTouchEnd: TouchEventHandler<HTMLInputElement>
Omit.onTouchEnd
+• Optional onTouchEndCapture: TouchEventHandler<HTMLInputElement>
Omit.onTouchEndCapture
+• Optional onTouchMove: TouchEventHandler<HTMLInputElement>
Omit.onTouchMove
+• Optional onTouchMoveCapture: TouchEventHandler<HTMLInputElement>
Omit.onTouchMoveCapture
+• Optional onTouchStart: TouchEventHandler<HTMLInputElement>
Omit.onTouchStart
+• Optional onTouchStartCapture: TouchEventHandler<HTMLInputElement>
Omit.onTouchStartCapture
+• Optional onTransitionEnd: TransitionEventHandler<HTMLInputElement>
Omit.onTransitionEnd
+• Optional onTransitionEndCapture: TransitionEventHandler<HTMLInputElement>
Omit.onTransitionEndCapture
+• Optional onVolumeChange: ReactEventHandler<HTMLInputElement>
Omit.onVolumeChange
+• Optional onVolumeChangeCapture: ReactEventHandler<HTMLInputElement>
Omit.onVolumeChangeCapture
+• Optional onWaiting: ReactEventHandler<HTMLInputElement>
Omit.onWaiting
+• Optional onWaitingCapture: ReactEventHandler<HTMLInputElement>
Omit.onWaitingCapture
+• Optional onWheel: WheelEventHandler<HTMLInputElement>
Omit.onWheel
+• Optional onWheelCapture: WheelEventHandler<HTMLInputElement>
Omit.onWheelCapture
+• Optional open: boolean
Omit.open
+• Optional optimum: number
Omit.optimum
+• Optional pattern: string
Omit.pattern
+• Optional placeholder: string
Omit.placeholder
+• Optional playsInline: boolean
Omit.playsInline
+• Optional poster: string
Omit.poster
+• Optional prefix: string
Omit.prefix
+• Optional preload: string
Omit.preload
+• Optional property: string
Omit.property
+• Optional radioGroup: string
Omit.radioGroup
+• Optional readOnly: boolean
Omit.readOnly
+• Optional ref: LegacyRef<HTMLInputElement>
Omit.ref
+• Optional rel: string
Omit.rel
+• Optional required: boolean
Omit.required
+• Optional resource: string
Omit.resource
+• Optional results: number
Omit.results
+• Optional reversed: boolean
Omit.reversed
+• Optional role: AriaRole
Omit.role
+• Optional rowSpan: number
Omit.rowSpan
+• Optional rows: number
Omit.rows
+• Optional sandbox: string
Omit.sandbox
+• Optional scope: string
Omit.scope
+• Optional scoped: boolean
Omit.scoped
+• Optional scrolling: string
Omit.scrolling
+• Optional seamless: boolean
Omit.seamless
+• Optional security: string
Omit.security
+• Optional selected: boolean
Omit.selected
+• Optional shape: string
Omit.shape
+• Optional size: number
Omit.size
+• Optional sizes: string
Omit.sizes
+• Optional slot: string
Omit.slot
+• Optional span: number
Omit.span
+• Optional spellCheck: Booleanish
Omit.spellCheck
+• Optional src: string
Omit.src
+• Optional srcDoc: string
Omit.srcDoc
+• Optional srcLang: string
Omit.srcLang
+• Optional srcSet: string
Omit.srcSet
+• Optional start: number
Omit.start
+• Optional step: string | number
Omit.step
+• Optional style: CSSProperties
Omit.style
+• Optional summary: string
Omit.summary
+• Optional suppressContentEditableWarning: boolean
Omit.suppressContentEditableWarning
+• Optional suppressHydrationWarning: boolean
Omit.suppressHydrationWarning
+• Optional tabIndex: number
Omit.tabIndex
+• Optional target: string
Omit.target
+• Optional title: string
Omit.title
+• Optional translate: "yes" | "no"
Omit.translate
+• Optional type: string
Omit.type
+• Optional typeof: string
Omit.typeof
+• Optional unselectable: "on" | "off"
Omit.unselectable
+• Optional useMap: string
Omit.useMap
+• Optional value: string | number | readonly string[]
Omit.value
+• Optional vocab: string
Omit.vocab
+• Optional width: string | number
Omit.width
+• Optional wmode: string
Omit.wmode
+• Optional wrap: string
Omit.wrap
+▸ Optional onChange(checked, event): void
| Name | +Type | +
|---|---|
checked |
+boolean |
+
event |
+ChangeEvent<HTMLInputElement> |
+
void
Renderer.Component.SwitcherProps
+SwitchProps↳ SwitcherProps
• Optional TouchRippleProps: Partial<TouchRippleProps>
Props applied to the TouchRipple element.
SwitchProps.TouchRippleProps
+• Optional about: string
SwitchProps.about
+• Optional accessKey: string
SwitchProps.accessKey
+• Optional action: Ref<ButtonBaseActions>
A ref for imperative actions.
+It currently only supports focusVisible() action.
SwitchProps.action
+• Optional aria-activedescendant: string
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
+SwitchProps.aria-activedescendant
+• Optional aria-atomic: Booleanish
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
+SwitchProps.aria-atomic
+• Optional aria-autocomplete: "list" | "none" | "inline" | "both"
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.
+SwitchProps.aria-autocomplete
+• Optional aria-busy: Booleanish
Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.
+SwitchProps.aria-busy
+• Optional aria-checked: boolean | "true" | "false" | "mixed"
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
+see aria-pressed @see aria-selected.
SwitchProps.aria-checked
+• Optional aria-colcount: number
Defines the total number of columns in a table, grid, or treegrid.
+see aria-colindex.
SwitchProps.aria-colcount
+• Optional aria-colindex: number
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
+see aria-colcount @see aria-colspan.
SwitchProps.aria-colindex
+• Optional aria-colspan: number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
+see aria-colindex @see aria-rowspan.
SwitchProps.aria-colspan
+• Optional aria-controls: string
Identifies the element (or elements) whose contents or presence are controlled by the current element.
+see aria-owns.
SwitchProps.aria-controls
+• Optional aria-current: boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date"
Indicates the element that represents the current item within a container or set of related elements.
+SwitchProps.aria-current
+• Optional aria-describedby: string
Identifies the element (or elements) that describes the object.
+see aria-labelledby
SwitchProps.aria-describedby
+• Optional aria-details: string
Identifies the element that provides a detailed, extended description for the object.
+see aria-describedby.
SwitchProps.aria-details
+• Optional aria-disabled: Booleanish
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
+see aria-hidden @see aria-readonly.
SwitchProps.aria-disabled
+• Optional aria-dropeffect: "link" | "none" | "copy" | "execute" | "move" | "popup"
Indicates what functions can be performed when a dragged object is released on the drop target.
+deprecated in ARIA 1.1
SwitchProps.aria-dropeffect
+• Optional aria-errormessage: string
Identifies the element that provides an error message for the object.
+see aria-invalid @see aria-describedby.
SwitchProps.aria-errormessage
+• Optional aria-expanded: Booleanish
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
+SwitchProps.aria-expanded
+• Optional aria-flowto: string
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.
+SwitchProps.aria-flowto
+• Optional aria-grabbed: Booleanish
Indicates an element's "grabbed" state in a drag-and-drop operation.
+deprecated in ARIA 1.1
SwitchProps.aria-grabbed
+• Optional aria-haspopup: boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
+SwitchProps.aria-haspopup
+• Optional aria-hidden: Booleanish
Indicates whether the element is exposed to an accessibility API.
+see aria-disabled.
SwitchProps.aria-hidden
+• Optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"
Indicates the entered value does not conform to the format expected by the application.
+see aria-errormessage.
SwitchProps.aria-invalid
+• Optional aria-keyshortcuts: string
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
+SwitchProps.aria-keyshortcuts
+• Optional aria-label: string
Defines a string value that labels the current element.
+see aria-labelledby.
SwitchProps.aria-label
+• Optional aria-labelledby: string
Identifies the element (or elements) that labels the current element.
+see aria-describedby.
SwitchProps.aria-labelledby
+• Optional aria-level: number
Defines the hierarchical level of an element within a structure.
+SwitchProps.aria-level
+• Optional aria-live: "off" | "assertive" | "polite"
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
+SwitchProps.aria-live
+• Optional aria-modal: Booleanish
Indicates whether an element is modal when displayed.
+SwitchProps.aria-modal
+• Optional aria-multiline: Booleanish
Indicates whether a text box accepts multiple lines of input or only a single line.
+SwitchProps.aria-multiline
+• Optional aria-multiselectable: Booleanish
Indicates that the user may select more than one item from the current selectable descendants.
+SwitchProps.aria-multiselectable
+• Optional aria-orientation: "horizontal" | "vertical"
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
+SwitchProps.aria-orientation
+• Optional aria-owns: string
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
+see aria-controls.
SwitchProps.aria-owns
+• Optional aria-placeholder: string
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.
+SwitchProps.aria-placeholder
+• Optional aria-posinset: number
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
+see aria-setsize.
SwitchProps.aria-posinset
+• Optional aria-pressed: boolean | "true" | "false" | "mixed"
Indicates the current "pressed" state of toggle buttons.
+see aria-checked @see aria-selected.
SwitchProps.aria-pressed
+• Optional aria-readonly: Booleanish
Indicates that the element is not editable, but is otherwise operable.
+see aria-disabled.
SwitchProps.aria-readonly
+• Optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"
Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
+see aria-atomic.
SwitchProps.aria-relevant
+• Optional aria-required: Booleanish
Indicates that user input is required on the element before a form may be submitted.
+SwitchProps.aria-required
+• Optional aria-roledescription: string
Defines a human-readable, author-localized description for the role of an element.
+SwitchProps.aria-roledescription
+• Optional aria-rowcount: number
Defines the total number of rows in a table, grid, or treegrid.
+see aria-rowindex.
SwitchProps.aria-rowcount
+• Optional aria-rowindex: number
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
+see aria-rowcount @see aria-rowspan.
SwitchProps.aria-rowindex
+• Optional aria-rowspan: number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
+see aria-rowindex @see aria-colspan.
SwitchProps.aria-rowspan
+• Optional aria-selected: Booleanish
Indicates the current "selected" state of various widgets.
+see aria-checked @see aria-pressed.
SwitchProps.aria-selected
+• Optional aria-setsize: number
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
+see aria-posinset.
SwitchProps.aria-setsize
+• Optional aria-sort: "none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
+SwitchProps.aria-sort
+• Optional aria-valuemax: number
Defines the maximum allowed value for a range widget.
+SwitchProps.aria-valuemax
+• Optional aria-valuemin: number
Defines the minimum allowed value for a range widget.
+SwitchProps.aria-valuemin
+• Optional aria-valuenow: number
Defines the current value for a range widget.
+see aria-valuetext.
SwitchProps.aria-valuenow
+• Optional aria-valuetext: string
Defines the human readable text alternative of aria-valuenow for a range widget.
+SwitchProps.aria-valuetext
+• Optional autoCapitalize: string
SwitchProps.autoCapitalize
+• Optional autoCorrect: string
SwitchProps.autoCorrect
+• Optional autoFocus: boolean
SwitchProps.autoFocus
+• Optional autoSave: string
SwitchProps.autoSave
+• Optional centerRipple: boolean
If true, the ripples will be centered.
+They won't start at the cursor interaction position.
SwitchProps.centerRipple
+• Optional checked: boolean
If true, the component is checked.
SwitchProps.checked
+• Optional checkedIcon: ReactNode
The icon to display when the component is checked.
+SwitchProps.checkedIcon
+• Optional className: string
SwitchProps.className
+• classes: Styles
SwitchProps.classes
+• Optional color: "default" | "primary" | "secondary"
The color of the component. It supports those theme colors that make sense for this component.
+SwitchProps.color
+• Optional contentEditable: Booleanish | "inherit"
SwitchProps.contentEditable
+• Optional contextMenu: string
SwitchProps.contextMenu
+• Optional dangerouslySetInnerHTML: Object
| Name | +Type | +
|---|---|
__html |
+string |
+
SwitchProps.dangerouslySetInnerHTML
+• Optional datatype: string
SwitchProps.datatype
+• Optional defaultChecked: boolean
SwitchProps.defaultChecked
+• Optional defaultValue: string | number | readonly string[]
SwitchProps.defaultValue
+• Optional dir: string
SwitchProps.dir
+• Optional disableFocusRipple: boolean
SwitchProps.disableFocusRipple
+• Optional disableRipple: boolean
If true, the ripple effect will be disabled.
SwitchProps.disableRipple
+• Optional disableTouchRipple: boolean
If true, the touch ripple effect will be disabled.
SwitchProps.disableTouchRipple
+• Optional disabled: boolean
If true, the switch will be disabled.
SwitchProps.disabled
+• Optional draggable: Booleanish
SwitchProps.draggable
+• Optional edge: false | "start" | "end"
If given, uses a negative margin to counteract the padding on one +side (this is often helpful for aligning the left or right +side of the icon with content above or below, without ruining the border +size and shape).
+SwitchProps.edge
+• Optional focusRipple: boolean
If true, the base button will have a keyboard focus ripple.
SwitchProps.focusRipple
+• Optional focusVisibleClassName: string
This prop can help identify which element has keyboard focus.
+The class name will be applied when the element gains the focus through keyboard interaction.
+It's a polyfill for the CSS :focus-visible selector.
+The rationale for using this feature is explained here.
+A polyfill can be used to apply a focus-visible class to other components
+if needed.
SwitchProps.focusVisibleClassName
+• Optional form: string
SwitchProps.form
+• Optional formAction: string
SwitchProps.formAction
+• Optional formEncType: string
SwitchProps.formEncType
+• Optional formMethod: string
SwitchProps.formMethod
+• Optional formNoValidate: boolean
SwitchProps.formNoValidate
+• Optional formTarget: string
SwitchProps.formTarget
+• Optional hidden: boolean
SwitchProps.hidden
+• Optional icon: ReactNode
The icon to display when the component is unchecked.
+SwitchProps.icon
+• Optional id: string
The id of the input element.
SwitchProps.id
+• Optional inlist: any
SwitchProps.inlist
+• Optional innerRef: Ref<any>
SwitchProps.innerRef
+• Optional inputMode: "text" | "none" | "search" | "tel" | "url" | "email" | "numeric" | "decimal"
Hints at the type of data that might be entered by the user while editing the element or its contents
+see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute
SwitchProps.inputMode
+• Optional inputProps: InputHTMLAttributes<HTMLInputElement>
Attributes applied to the input element.
SwitchProps.inputProps
+• Optional inputRef: Ref<any>
Pass a ref to the input element.
SwitchProps.inputRef
+• 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
SwitchProps.is
+• Optional itemID: string
SwitchProps.itemID
+• Optional itemProp: string
SwitchProps.itemProp
+• Optional itemRef: string
SwitchProps.itemRef
+• Optional itemScope: boolean
SwitchProps.itemScope
+• Optional itemType: string
SwitchProps.itemType
+• Optional key: Key
SwitchProps.key
+• Optional lang: string
SwitchProps.lang
+• Optional name: string
Name attribute of the input element.
SwitchProps.name
+• Optional onAbort: ReactEventHandler<HTMLButtonElement>
SwitchProps.onAbort
+• Optional onAbortCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onAbortCapture
+• Optional onAnimationEnd: AnimationEventHandler<HTMLButtonElement>
SwitchProps.onAnimationEnd
+• Optional onAnimationEndCapture: AnimationEventHandler<HTMLButtonElement>
SwitchProps.onAnimationEndCapture
+• Optional onAnimationIteration: AnimationEventHandler<HTMLButtonElement>
SwitchProps.onAnimationIteration
+• Optional onAnimationIterationCapture: AnimationEventHandler<HTMLButtonElement>
SwitchProps.onAnimationIterationCapture
+• Optional onAnimationStart: AnimationEventHandler<HTMLButtonElement>
SwitchProps.onAnimationStart
+• Optional onAnimationStartCapture: AnimationEventHandler<HTMLButtonElement>
SwitchProps.onAnimationStartCapture
+• Optional onAuxClick: MouseEventHandler<HTMLButtonElement>
SwitchProps.onAuxClick
+• Optional onAuxClickCapture: MouseEventHandler<HTMLButtonElement>
SwitchProps.onAuxClickCapture
+• Optional onBeforeInput: FormEventHandler<HTMLButtonElement>
SwitchProps.onBeforeInput
+• Optional onBeforeInputCapture: FormEventHandler<HTMLButtonElement>
SwitchProps.onBeforeInputCapture
+• Optional onBlur: FocusEventHandler<HTMLButtonElement>
SwitchProps.onBlur
+• Optional onBlurCapture: FocusEventHandler<HTMLButtonElement>
SwitchProps.onBlurCapture
+• Optional onCanPlay: ReactEventHandler<HTMLButtonElement>
SwitchProps.onCanPlay
+• Optional onCanPlayCapture: ReactEventHandler<HTMLButtonElement>
SwitchProps.onCanPlayCapture
+• Optional onCanPlayThrough: ReactEventHandler<HTMLButtonElement>
SwitchProps.onCanPlayThrough
+• Optional onCanPlayThroughCapture: ReactEventHandler<HTMLButtonElement>
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>
SwitchProps.onKeyPress
+• Optional onKeyPressCapture: KeyboardEventHandler<HTMLButtonElement>
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: Ref<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
Callback fired when the state is changed.
+| Name | +Type | +Description | +
|---|---|---|
event |
+ChangeEvent<HTMLInputElement> |
+The event source of the callback. You can pull out the new value by accessing event.target.value (string). You can pull out the new checked state by accessing event.target.checked (boolean). |
+
checked |
+boolean |
+- | +
void
SwitchProps.onChange
+ + + + + + + +• Optional _sorting: Partial<TableSortParams>
• Optional _sorting: Partial<TableSortParams>
internal
• Optional selectedItemId: string
• Optional sortByDefault: Partial<TableSortParams>
• Optional sortByDefault: Partial<TableSortParams>
• Optional sortSyncWithUrl: boolean
overflow-y: scroll,
paramsTableSortParamsTableSortParamsRenderer.Component.WizardCommonProps
+| Name | +
|---|
D |
+
WizardCommonProps• Optional data: Partial<D>
• Optional hideSteps: boolean
▸ Optional done(): void
void
▸ Optional reset(): void
void
▸ Optional save(data, callback?): void
| Name | +Type | +
|---|---|
data |
+Partial<D> |
+
callback? |
+() => void |
+
void
Renderer.Component.WizardProps
+| Name | +
|---|
D |
+
WizardCommonPropsWizardCommonProps<D>↳ WizardProps
• Optional children: ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>> | ReactElement<WizardStepProps<D>, string | JSXElementConstructor<any>>[]
• Optional className: string
• Optional data: Partial<any>
• Optional data: Partial<D>
WizardCommonProps.data
+• Optional header: ReactNode
• Optional hideSteps: boolean
WizardCommonProps.hideSteps
+• Optional step: number
void
WizardCommonProps.done
+▸ Optional onChange(step): void
void
WizardCommonProps.reset
+▸ Optional save(data, callback?): void
void
WizardCommonProps.save
+ diff --git a/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html b/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html index 1541da746e..c9ff8f0c54 100644 --- a/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html +++ b/master/extensions/api/interfaces/Renderer.Component.WizardStepProps/index.html @@ -1009,19 +1009,17 @@DanyWizardCommonProps<D>WizardCommonProps<D>↳ WizardStepProps
• Optional data: Partial<D>
WizardCommonProps.data
+• Optional disabledNext: boolean
• Optional hideSteps: boolean
WizardCommonProps.hideSteps
+• Optional loading: boolean
• Optional waiting: boolean
• Optional wizard: Wizard
• Optional wizard: Wizard<D>
▸ Optional done(): void
void
WizardCommonProps.done
+▸ Optional first(): void
void
WizardCommonProps.reset
+▸ Optional save(data, callback?): void
void
WizardCommonProps.save
+ diff --git a/master/extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/index.html b/master/extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/index.html new file mode 100644 index 0000000000..0311dacf70 --- /dev/null +++ b/master/extensions/api/interfaces/Renderer.K8sApi.KubeObjectStatus/index.html @@ -0,0 +1,874 @@ + + + + + + + + + + + + + + + + + + + + + + + + + +Renderer.K8sApi.KubeObjectStatus
+Copyright (c) OpenLens Authors. All rights reserved. +Licensed under MIT License. See LICENSE in root directory for more information.
+• level: KubeObjectStatusLevel
• text: string
• Optional timestamp: string
Ƭ KubernetesClusterStatusPhase: "connected" | "connecting" | "disconnected" | "deleting"
deprecated This is no longer used as it is incorrect. Other sources can add more values
Ƭ WebLinkSpec: Object
| Name | -Type | -
|---|---|
url |
-string |
-
Ƭ WebLinkStatusPhase: "available" | "unavailable"
Common.EventBus
Ƭ AppEvent: Object
| Name | -Type | -
|---|---|
action |
-string |
-
name |
-string |
-
params? |
-object |
-
• appEventBus: EventEmitter<[AppEvent]>
• appEventBus: EventEmitter<[AppEvent]>
Copyright (c) OpenLens Authors. All rights reserved. Licensed under MIT License. See LICENSE in root directory for more information.
diff --git a/master/extensions/api/modules/Renderer.Component/index.html b/master/extensions/api/modules/Renderer.Component/index.html index 2ac8ce9017..7033a1da8b 100644 --- a/master/extensions/api/modules/Renderer.Component/index.html +++ b/master/extensions/api/modules/Renderer.Component/index.html @@ -870,13 +870,6 @@ TableSortCallbacks -Ƭ TableSortParams: Object
| Name | -Type | -
|---|---|
orderBy |
-TableOrderBy |
-
sortBy |
-TableSortBy |
-
• CommandOverlay: CommandOverlay
• InputValidators: Object
__namedParameters |
-Props |
+SwitchProps |
Ƭ KubeObjectStatus: Object
Copyright (c) OpenLens Authors. All rights reserved. -Licensed under MIT License. See LICENSE in root directory for more information.
-| Name | -Type | -
|---|---|
level |
-KubeObjectStatusLevel |
-
text |
-string |
-
timestamp? |
-string |
-
• apiManager: ApiManager
PodsDetailsList,
type Pod = Renderer.K8sApi.Pod;
-interface Props {
+interface PodsDetailsListProps {
pods?: Pod[];
}
-export class PodsDetailsList extends React.Component<Props> {
+export class PodsDetailsList extends React.Component<PodsDetailsListProps> {
getTableRow = (pod: Pod) => {
return (
<TableRow key={index} nowrap>
diff --git a/master/extensions/guides/resource-stack/index.html b/master/extensions/guides/resource-stack/index.html
index 35156f9f1b..1704c9500d 100644
--- a/master/extensions/guides/resource-stack/index.html
+++ b/master/extensions/guides/resource-stack/index.html
@@ -827,13 +827,13 @@ This method can be useful in creating a context-sensitive UI for installing/unin
}
} = Renderer;
- interface Props {
+ interface ExampleClusterFeatureSettingsProps {
cluster: Common.Catalog.KubernetesCluster;
}
@observer
- export class ExampleClusterFeatureSettings extends React.Component<Props> {
- constructor(props: Props) {
+ export class ExampleClusterFeatureSettings extends React.Component<ExampleClusterFeatureSettingsProps> {
+ constructor(props: ExampleClusterFeatureSettingsProps) {
super(props);
makeObservable(this);
}
diff --git a/master/search/search_index.json b/master/search/search_index.json
index 89c5fb46c2..e2d0a12cde 100644
--- a/master/search/search_index.json
+++ b/master/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Lens Extension API # Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started. What Extensions Can Do # Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API. How to Build Extensions # Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. What's New # Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes . Important changes since Lens v4 # Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5. Looking for Help # If you have questions for extension development, try asking on the Lens Dev Slack . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension . Downloading Lens # Download Lens for macOS, Windows, or Linux.","title":"Overview"},{"location":"#lens-extension-api","text":"Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started.","title":"Lens Extension API"},{"location":"#what-extensions-can-do","text":"Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.","title":"What Extensions Can Do"},{"location":"#how-to-build-extensions","text":"Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.","title":"How to Build Extensions"},{"location":"#whats-new","text":"Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes .","title":"What's New"},{"location":"#important-changes-since-lens-v4","text":"Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5.","title":"Important changes since Lens v4"},{"location":"#looking-for-help","text":"If you have questions for extension development, try asking on the Lens Dev Slack . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension .","title":"Looking for Help"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"extensions/extension-migration/","text":"Lens v4 to v5 Extension Migration Notes # Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( Main and Renderer ) plus those not specific to a process ( Common ). For example the LensMainExtension class is now referred to by Main.LensExtension . See the API Reference for the new organization. The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension ) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu. The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension ) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/extension-migration/#lens-v4-to-v5-extension-migration-notes","text":"Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( Main and Renderer ) plus those not specific to a process ( Common ). For example the LensMainExtension class is now referred to by Main.LensExtension . See the API Reference for the new organization. The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension ) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu. The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension ) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/api/","text":"Extension API Reference # APIs # Common Main Renderer","title":"API Reference"},{"location":"extensions/api/#extension-api-reference","text":"","title":"Extension API Reference"},{"location":"extensions/api/#apis","text":"Common Main Renderer","title":"APIs"},{"location":"extensions/api/modules/","text":"@k8slens/extensions # Table of contents # Namespaces # Common Main Renderer","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#k8slensextensions","text":"","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/#namespaces","text":"Common Main Renderer","title":"Namespaces"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/","text":"Class: CatalogCategory # Common . Catalog .CatalogCategory Hierarchy # TypedEventEmitter < CatalogCategoryEvents , this > \u21b3 CatalogCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new CatalogCategory () Inherited from # (EventEmitter as new () => TypedEmitter