Namespace: Component#
Renderer.Component
Table of contents#
Enumerations#
Classes#
- DrawerParamToggler
- Input
- Menu
- MenuItem
- NotificationsStore
- PageLayout
- PodDetailsList
- SearchInput
- SettingLayout
- Slider
- Spinner
- Stepper
- SubTitle
- Tab
- TableCell
- TableHead
- TableRow
- Tabs
- TerminalStore
- Tooltip
- Wizard
- WizardLayout
- WizardStep
Interfaces#
- AdditionalCategoryColumnRegistration
- BadgeProps
- BarChartProps
- BaseIconProps
- ButtonProps
- CategoryColumnRegistration
- CheckboxProps
- ConfirmDialogBooleanParams
- ConfirmDialogParams
- ConfirmDialogProps
- CreateNotificationOptions
- CustomPlaceholderProps
- DialogProps
- DrawerItemLabelsProps
- DrawerItemProps
- DrawerParamTogglerProps
- DrawerProps
- DrawerTitleProps
- IconDataFnArg
- IconProps
- KubeEventDetailsProps
- KubeObjectDetailsProps
- KubeObjectListLayoutProps
- KubeObjectMenuProps
- KubeObjectMetaProps
- LineProgressProps
- MainLayoutProps
- MenuActionsProps
- MenuItemProps
- MenuPosition
- MenuProps
- MenuStyle
- MonacoEditorProps
- NamespaceSelectProps
- Notification
- PieChartData
- PieChartProps
- PodDetailsListProps
- RadioGroupProps
- RadioProps
- SearchInputProps
- SelectOption
- SelectProps
- SettingLayoutProps
- SliderProps
- SpinnerProps
- StatusBrickProps
- StepperProps
- SubTitleProps
- SwitchProps
- SwitcherProps
- TabLayoutProps
- TabLayoutRoute
- TabProps
- TableCellProps
- TableHeadProps
- TableProps
- TableRowProps
- TableSortParams
- TabsProps
- TooltipContentFormatters
- TooltipDecoratorProps
- TooltipProps
- WizardCommonProps
- WizardLayoutProps
- WizardProps
- WizardStepProps
Type Aliases#
- DatasetTooltipLabel
- DrawerPosition
- IconData
- InputProps
- InputValidation
- InputValidationResult
- InputValidator
- LegacyAutoConvertedOptions
- MenuContextValue
- MonacoCustomTheme
- MonacoEditorId
- MonacoTheme
- NamespaceSelectSort
- NotificationId
- NotificationMessage
- ShowNotification
- SyncValidationMessage
- TableCellElem
- TableHeadElem
- TableOrderBy
- TableRowElem
- TableSortBy
- TableSortCallback
- TableSortCallbacks
Variables#
- CommandOverlay
- InputValidators
- MenuContext
- Switcher
- cpuOptions
- logTabStore
- memoryOptions
- notificationsStore
- resizingAnchorProps
- terminalStore
Functions#
- Badge
- BarChart
- Button
- Checkbox
- ConfirmDialog
- Dialog
- Drawer
- DrawerItem
- DrawerItemLabels
- DrawerTitle
- FormSwitch
- Icon
- KubeEventDetails
- KubeObjectDetails
- KubeObjectListLayout
- KubeObjectMenu
- KubeObjectMeta
- LineProgress
- MainLayout
- MenuActions
- MonacoEditor
- NamespaceSelect
- NamespaceSelectFilter
- Notifications
- PieChart
- Radio
- RadioGroup
- Select
- StatusBrick
- SubMenu
- Switch
- TabLayout
- Table
- asyncInputValidator
- createTerminalTab
- getDetailsUrl
- inputValidator
- isAsyncValidator
- isSvg
- onMultiSelectFor
- showDetails
- unionInputValidatorsAsync
- withTooltip
Type Aliases#
DatasetTooltipLabel#
Ƭ DatasetTooltipLabel: (percent
: string
) => string
| string
Type declaration#
▸ (percent
): string
| string
Parameters#
Name | Type |
---|---|
percent |
string |
Returns#
string
| string
DrawerPosition#
Ƭ DrawerPosition: "top"
| "left"
| "right"
| "bottom"
IconData#
Ƭ IconData: string
| React.ReactNode
| (opt
: IconDataFnArg
) => React.ReactNode
One of the folloing: - A material icon name - A react node - Or a function that produces a react node
InputProps#
Ƭ InputProps: Omit
<InputElementProps
, "onChange"
| "onSubmit"
> & { autoSelectOnFocus?
: boolean
; blurOnEnter?
: boolean
; className?
: string
; contentRight?
: string
| React.ReactNode
; defaultValue?
: string
; dirty?
: boolean
; iconLeft?
: IconData
; iconRight?
: IconData
; maxRows?
: number
; multiLine?
: boolean
; showErrorsAsTooltip?
: boolean
| Omit
<TooltipProps
, "targetId"
> ; showValidationLine?
: boolean
; theme?
: "round-black"
| "round"
; trim?
: boolean
; validators?
: InputValidator
<boolean
> | InputValidator
<boolean
>[] ; value?
: string
; onChange?
: (value
: string
, evt
: ChangeEvent
<InputElement
>) => void
; onSubmit?
: (value
: string
, evt
: KeyboardEvent
<InputElement
>) => void
}
InputValidation#
Ƭ InputValidation<IsAsync
>: (value
: string
, props?
: InputProps
) => InputValidationResult
<IsAsync
>
Type parameters#
Name | Type |
---|---|
IsAsync |
extends boolean |
Type declaration#
▸ (value
, props?
): InputValidationResult
<IsAsync
>
Parameters#
Name | Type |
---|---|
value |
string |
props? |
InputProps |
Returns#
InputValidationResult
<IsAsync
>
InputValidationResult#
Ƭ InputValidationResult<IsAsync
>: IsAsync
extends true
? Promise
<void
> : boolean
Type parameters#
Name | Type |
---|---|
IsAsync |
extends boolean |
InputValidator#
Ƭ InputValidator<IsAsync
>: SyncInputValidator
| AsyncInputValidator
| IsAsync
extends boolean
? LegacyInputValidator
: never
Type parameters#
Name | Type |
---|---|
IsAsync |
extends boolean = boolean |
LegacyAutoConvertedOptions#
Ƭ LegacyAutoConvertedOptions: string
[]
deprecated
This should not be used anymore, convert the options yourself.
MenuContextValue#
Ƭ MenuContextValue: Menu
MonacoCustomTheme#
Ƭ MonacoCustomTheme: "clouds-midnight"
MonacoEditorId#
Ƭ MonacoEditorId: string
MonacoTheme#
Ƭ MonacoTheme: "vs"
| "vs-dark"
| "hc-black"
| MonacoCustomTheme
NamespaceSelectSort#
Ƭ NamespaceSelectSort: (left
: string
, right
: string
) => number
Type declaration#
▸ (left
, right
): number
Parameters#
Name | Type |
---|---|
left |
string |
right |
string |
Returns#
number
NotificationId#
Ƭ NotificationId: string
| number
NotificationMessage#
Ƭ NotificationMessage: string
| React.ReactElement
| React.ReactElement
[] | JsonApiErrorParsed
| Error
ShowNotification#
Ƭ ShowNotification: (message
: NotificationMessage
, opts?
: CreateNotificationOptions
) => Disposer
Type declaration#
▸ (message
, opts?
): Disposer
Parameters#
Name | Type |
---|---|
message |
NotificationMessage |
opts? |
CreateNotificationOptions |
Returns#
Disposer
SyncValidationMessage#
Ƭ SyncValidationMessage: React.ReactNode
| (value
: string
, props?
: InputProps
) => React.ReactNode
TableCellElem#
Ƭ TableCellElem: React.ReactElement
<TableCellProps
>
TableHeadElem#
Ƭ TableHeadElem: React.ReactElement
<TableHeadProps
>
TableOrderBy#
Ƭ TableOrderBy: "asc"
| "desc"
TableRowElem#
Ƭ TableRowElem<Item
>: React.ReactElement
<TableRowProps
<Item
>>
Type parameters#
Name |
---|
Item |
TableSortBy#
Ƭ TableSortBy: string
TableSortCallback#
Ƭ TableSortCallback<Item
>: (data
: Item
) => undefined
| string
| number
| (string
| number
)[]
Type parameters#
Name |
---|
Item |
Type declaration#
▸ (data
): undefined
| string
| number
| (string
| number
)[]
Parameters#
Name | Type |
---|---|
data |
Item |
Returns#
undefined
| string
| number
| (string
| number
)[]
TableSortCallbacks#
Ƭ TableSortCallbacks<Item
>: Record
<string
, TableSortCallback
<Item
>>
Type parameters#
Name |
---|
Item |
Variables#
CommandOverlay#
• Const
CommandOverlay: CommandOverlay
InputValidators#
• InputValidators: Object
Type declaration#
Name | Type |
---|---|
accountId |
SyncInputValidator |
isEmail |
SyncInputValidator |
isExtensionNameInstall |
SyncInputValidator |
isExtensionNameInstallRegex |
{ captures : (val : string ) => undefined | { name : string ; version? : string } ; isMatch : (val : string ) => boolean } |
isExtensionNameInstallRegex.captures |
[object Object] |
isExtensionNameInstallRegex.isMatch |
[object Object] |
isNumber |
SyncInputValidator |
isPath |
AsyncInputValidator |
isRequired |
SyncInputValidator |
isUrl |
SyncInputValidator |
maxLength |
SyncInputValidator |
minLength |
SyncInputValidator |
systemName |
SyncInputValidator |
unionInputValidators |
(baseValidator : Pick <SyncInputValidator , "message" | "condition" >, ...validators : SyncInputValidator []) => SyncInputValidator |
MenuContext#
• Const
MenuContext: Context
<null
| Menu
>
Switcher#
• Const
Switcher: ComponentType
<Pick
<SwitcherProps
, "key"
| "value"
| "id"
| "icon"
| "prefix"
| "size"
| "name"
| "onError"
| "type"
| "required"
| "className"
| "dir"
| "form"
| "slot"
| "style"
| "title"
| "onChange"
| "defaultValue"
| "tabIndex"
| "readOnly"
| "disabled"
| "dangerouslySetInnerHTML"
| "onCopy"
| "onCopyCapture"
| "onCut"
| "onCutCapture"
| "onPaste"
| "onPasteCapture"
| "onCompositionEnd"
| "onCompositionEndCapture"
| "onCompositionStart"
| "onCompositionStartCapture"
| "onCompositionUpdate"
| "onCompositionUpdateCapture"
| "onFocus"
| "onFocusCapture"
| "onBlur"
| "onBlurCapture"
| "onChangeCapture"
| "onBeforeInput"
| "onBeforeInputCapture"
| "onInput"
| "onInputCapture"
| "onReset"
| "onResetCapture"
| "onSubmit"
| "onSubmitCapture"
| "onInvalid"
| "onInvalidCapture"
| "onLoad"
| "onLoadCapture"
| "onErrorCapture"
| "onKeyDown"
| "onKeyDownCapture"
| "onKeyPress"
| "onKeyPressCapture"
| "onKeyUp"
| "onKeyUpCapture"
| "onAbort"
| "onAbortCapture"
| "onCanPlay"
| "onCanPlayCapture"
| "onCanPlayThrough"
| "onCanPlayThroughCapture"
| "onDurationChange"
| "onDurationChangeCapture"
| "onEmptied"
| "onEmptiedCapture"
| "onEncrypted"
| "onEncryptedCapture"
| "onEnded"
| "onEndedCapture"
| "onLoadedData"
| "onLoadedDataCapture"
| "onLoadedMetadata"
| "onLoadedMetadataCapture"
| "onLoadStart"
| "onLoadStartCapture"
| "onPause"
| "onPauseCapture"
| "onPlay"
| "onPlayCapture"
| "onPlaying"
| "onPlayingCapture"
| "onProgress"
| "onProgressCapture"
| "onRateChange"
| "onRateChangeCapture"
| "onSeeked"
| "onSeekedCapture"
| "onSeeking"
| "onSeekingCapture"
| "onStalled"
| "onStalledCapture"
| "onSuspend"
| "onSuspendCapture"
| "onTimeUpdate"
| "onTimeUpdateCapture"
| "onVolumeChange"
| "onVolumeChangeCapture"
| "onWaiting"
| "onWaitingCapture"
| "onAuxClick"
| "onAuxClickCapture"
| "onClick"
| "onClickCapture"
| "onContextMenu"
| "onContextMenuCapture"
| "onDoubleClick"
| "onDoubleClickCapture"
| "onDrag"
| "onDragCapture"
| "onDragEnd"
| "onDragEndCapture"
| "onDragEnter"
| "onDragEnterCapture"
| "onDragExit"
| "onDragExitCapture"
| "onDragLeave"
| "onDragLeaveCapture"
| "onDragOver"
| "onDragOverCapture"
| "onDragStart"
| "onDragStartCapture"
| "onDrop"
| "onDropCapture"
| "onMouseDown"
| "onMouseDownCapture"
| "onMouseEnter"
| "onMouseLeave"
| "onMouseMove"
| "onMouseMoveCapture"
| "onMouseOut"
| "onMouseOutCapture"
| "onMouseOver"
| "onMouseOverCapture"
| "onMouseUp"
| "onMouseUpCapture"
| "onSelect"
| "onSelectCapture"
| "onTouchCancel"
| "onTouchCancelCapture"
| "onTouchEnd"
| "onTouchEndCapture"
| "onTouchMove"
| "onTouchMoveCapture"
| "onTouchStart"
| "onTouchStartCapture"
| "onPointerDown"
| "onPointerDownCapture"
| "onPointerMove"
| "onPointerMoveCapture"
| "onPointerUp"
| "onPointerUpCapture"
| "onPointerCancel"
| "onPointerCancelCapture"
| "onPointerEnter"
| "onPointerEnterCapture"
| "onPointerLeave"
| "onPointerLeaveCapture"
| "onPointerOver"
| "onPointerOverCapture"
| "onPointerOut"
| "onPointerOutCapture"
| "onGotPointerCapture"
| "onGotPointerCaptureCapture"
| "onLostPointerCapture"
| "onLostPointerCaptureCapture"
| "onScroll"
| "onScrollCapture"
| "onWheel"
| "onWheelCapture"
| "onAnimationStart"
| "onAnimationStartCapture"
| "onAnimationEnd"
| "onAnimationEndCapture"
| "onAnimationIteration"
| "onAnimationIterationCapture"
| "onTransitionEnd"
| "onTransitionEndCapture"
| "ref"
| "role"
| "defaultChecked"
| "suppressContentEditableWarning"
| "suppressHydrationWarning"
| "accessKey"
| "contentEditable"
| "contextMenu"
| "draggable"
| "hidden"
| "lang"
| "placeholder"
| "spellCheck"
| "translate"
| "radioGroup"
| "about"
| "datatype"
| "inlist"
| "property"
| "resource"
| "typeof"
| "vocab"
| "autoCapitalize"
| "autoCorrect"
| "autoSave"
| "color"
| "itemProp"
| "itemScope"
| "itemType"
| "itemID"
| "itemRef"
| "results"
| "security"
| "unselectable"
| "inputMode"
| "is"
| "aria-activedescendant"
| "aria-atomic"
| "aria-autocomplete"
| "aria-busy"
| "aria-checked"
| "aria-colcount"
| "aria-colindex"
| "aria-colspan"
| "aria-controls"
| "aria-current"
| "aria-describedby"
| "aria-details"
| "aria-disabled"
| "aria-dropeffect"
| "aria-errormessage"
| "aria-expanded"
| "aria-flowto"
| "aria-grabbed"
| "aria-haspopup"
| "aria-hidden"
| "aria-invalid"
| "aria-keyshortcuts"
| "aria-label"
| "aria-labelledby"
| "aria-level"
| "aria-live"
| "aria-modal"
| "aria-multiline"
| "aria-multiselectable"
| "aria-orientation"
| "aria-owns"
| "aria-placeholder"
| "aria-posinset"
| "aria-pressed"
| "aria-readonly"
| "aria-relevant"
| "aria-required"
| "aria-roledescription"
| "aria-rowcount"
| "aria-rowindex"
| "aria-rowspan"
| "aria-selected"
| "aria-setsize"
| "aria-sort"
| "aria-valuemax"
| "aria-valuemin"
| "aria-valuenow"
| "aria-valuetext"
| "innerRef"
| "inputProps"
| "checked"
| "autoFocus"
| "action"
| "formAction"
| "formEncType"
| "formMethod"
| "formNoValidate"
| "formTarget"
| "checkedIcon"
| "disableFocusRipple"
| "edge"
| "buttonRef"
| "centerRipple"
| "disableRipple"
| "disableTouchRipple"
| "focusRipple"
| "focusVisibleClassName"
| "onFocusVisible"
| "TouchRippleProps"
| "inputRef"
> & StyledComponentProps
<"track"
| "checked"
| "root"
| "thumb"
| "focusVisible"
| "switchBase"
>>
deprecated
Use
cpuOptions#
• Const
cpuOptions: ChartOptions
logTabStore#
• Const
logTabStore: LogTabStore
& { createPodTab
: (__namedParameters
: PodLogsTabData
) => string
; createWorkloadTab
: (__namedParameters
: WorkloadLogsTabData
) => undefined
| string
; renameTab
: (tabId
: string
) => void
; tabs
: undefined
= undefined }
memoryOptions#
• Const
memoryOptions: ChartOptions
notificationsStore#
• Const
notificationsStore: NotificationsStore
resizingAnchorProps#
• Const
resizingAnchorProps: Record
<DrawerPosition
, [ResizeDirection
, ResizeSide
, ResizeGrowthDirection
]>
terminalStore#
• Const
terminalStore: TerminalStore
& { sendCommand
: (command
: string
, options
: SendCommandOptions
) => Promise
<void
> }
Functions#
Badge#
▸ Badge(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <BadgeProps & TooltipDecoratorProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
BarChart#
▸ BarChart(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <BarChartProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
Button#
▸ Button(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <ButtonProps & TooltipDecoratorProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
Checkbox#
▸ Checkbox(__namedParameters
): Element
Parameters#
Name | Type |
---|---|
__namedParameters |
CheckboxProps |
Returns#
Element
ConfirmDialog#
▸ ConfirmDialog(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <ConfirmDialogProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
Dialog#
▸ Dialog(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <DialogProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
Drawer#
▸ Drawer(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <DrawerProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
DrawerItem#
▸ DrawerItem(__namedParameters
): null
| Element
Parameters#
Name | Type |
---|---|
__namedParameters |
DrawerItemProps |
Returns#
null
| Element
DrawerItemLabels#
▸ DrawerItemLabels(props
): null
| Element
Parameters#
Name | Type |
---|---|
props |
DrawerItemLabelsProps |
Returns#
null
| Element
DrawerTitle#
▸ DrawerTitle(__namedParameters
): Element
Parameters#
Name | Type |
---|---|
__namedParameters |
DrawerTitleProps |
Returns#
Element
FormSwitch#
▸ FormSwitch(props
): Element
deprecated
Use
Parameters#
Name | Type |
---|---|
props |
FormControlLabelProps |
Returns#
Element
Icon#
▸ Icon(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <IconProps & TooltipDecoratorProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
KubeEventDetails#
▸ KubeEventDetails(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <KubeEventDetailsProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
KubeObjectDetails#
▸ KubeObjectDetails(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
Object |
props.children? |
ReactNode |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
KubeObjectListLayout#
▸ KubeObjectListLayout<K
, A
, D
>(props
): ReactElement
<any
, string
| JSXElementConstructor
<any
>>
Type parameters#
Name | Type |
---|---|
K |
extends KubeObject <KubeObjectMetadata <KubeObjectScope >, unknown , unknown , K > |
A |
extends KubeApi <K , D , A > |
D |
extends KubeJsonApiData <KubeObjectMetadata <KubeObjectScope >, unknown , unknown , D > = KubeJsonApiDataFor <K > |
Parameters#
Name | Type |
---|---|
props |
KubeObjectListLayoutProps <K , A , D > |
Returns#
ReactElement
<any
, string
| JSXElementConstructor
<any
>>
KubeObjectMenu#
▸ KubeObjectMenu<T
>(props
): ReactElement
<any
, string
| JSXElementConstructor
<any
>>
Type parameters#
Name | Type |
---|---|
T |
extends KubeObject <KubeObjectMetadata <KubeObjectScope >, unknown , unknown , T > |
Parameters#
Name | Type |
---|---|
props |
KubeObjectMenuProps <T > |
Returns#
ReactElement
<any
, string
| JSXElementConstructor
<any
>>
KubeObjectMeta#
▸ KubeObjectMeta(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <KubeObjectMetaProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
LineProgress#
▸ LineProgress(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <LineProgressProps & TooltipDecoratorProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
MainLayout#
▸ MainLayout(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <MainLayoutProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
MenuActions#
▸ MenuActions(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <MenuActionsProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
MonacoEditor#
▸ MonacoEditor(props
): null
| ReactElement
<any
, string
| JSXElementConstructor
<any
>>
NOTE: Exotic components are not callable.
Parameters#
Name | Type |
---|---|
props |
MonacoEditorProps & RefAttributes <MonacoEditorRef > |
Returns#
null
| ReactElement
<any
, string
| JSXElementConstructor
<any
>>
NamespaceSelect#
▸ NamespaceSelect<IsMulti
>(props
): JSX.Element
Type parameters#
Name | Type |
---|---|
IsMulti |
extends boolean = false |
Parameters#
Name | Type |
---|---|
props |
NamespaceSelectProps <IsMulti > |
Returns#
JSX.Element
NamespaceSelectFilter#
▸ NamespaceSelectFilter(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <NamespaceSelectFilterProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
Notifications#
▸ Notifications(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
Object |
props.children? |
ReactNode |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
PieChart#
▸ PieChart(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <PieChartProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
Radio#
▸ Radio<T
>(__namedParameters
): Element
Type parameters#
Name |
---|
T |
Parameters#
Name | Type |
---|---|
__namedParameters |
RadioProps <T > |
Returns#
Element
RadioGroup#
▸ RadioGroup<T
>(__namedParameters
): Element
Type parameters#
Name |
---|
T |
Parameters#
Name | Type |
---|---|
__namedParameters |
RadioGroupProps <T > |
Returns#
Element
Select#
▸ Select<Value
, Option
, IsMulti
, Group
>(props
): ReactElement
<any
, string
| JSXElementConstructor
<any
>>
Type parameters#
Name | Type |
---|---|
Value |
Value |
Option |
extends SelectOption <Value , Option > |
IsMulti |
extends boolean = false |
Group |
extends GroupBase <Option , Group > = GroupBase <Option > |
Parameters#
Name | Type |
---|---|
props |
SelectProps <Value , Option , IsMulti , Group > |
Returns#
ReactElement
<any
, string
| JSXElementConstructor
<any
>>
StatusBrick#
▸ StatusBrick(props
, context?
): null
| ReactElement
<any
, any
>
Parameters#
Name | Type |
---|---|
props |
PropsWithChildren <StatusBrickProps & TooltipDecoratorProps > |
context? |
any |
Returns#
null
| ReactElement
<any
, any
>
SubMenu#
▸ SubMenu(props
): Element
Parameters#
Name | Type |
---|---|
props |
Partial <MenuProps > |
Returns#
Element
Switch#
▸ Switch(__namedParameters
): Element
Parameters#
Name | Type |
---|---|
__namedParameters |
SwitchProps |
Returns#
Element
TabLayout#
▸ TabLayout(__namedParameters
): Element
Parameters#
Name | Type |
---|---|
__namedParameters |
TabLayoutProps |
Returns#
Element
Table#
▸ Table<Item
>(props
): ReactElement
<any
, string
| JSXElementConstructor
<any
>>
Type parameters#
Name |
---|
Item |
Parameters#
Name | Type |
---|---|
props |
TableProps <Item > |
Returns#
ReactElement
<any
, string
| JSXElementConstructor
<any
>>
asyncInputValidator#
▸ asyncInputValidator(validator
): AsyncInputValidator
A helper function to create an AsyncInputValidator
Parameters#
Name | Type |
---|---|
validator |
AsyncInputValidator |
Returns#
AsyncInputValidator
createTerminalTab#
▸ createTerminalTab(tabParams?
): Required
<DockTabCreate
>
Parameters#
Name | Type |
---|---|
tabParams |
DockTabCreateSpecific |
Returns#
Required
<DockTabCreate
>
getDetailsUrl#
▸ getDetailsUrl(selfLink
, resetSelected?
, mergeGlobals?
): string
Parameters#
Name | Type |
---|---|
selfLink |
string |
resetSelected? |
boolean |
mergeGlobals? |
boolean |
Returns#
string
inputValidator#
▸ inputValidator(validator
): SyncInputValidator
A helper function to create an SyncInputValidator
Parameters#
Name | Type |
---|---|
validator |
SyncInputValidator |
Returns#
SyncInputValidator
isAsyncValidator#
▸ isAsyncValidator(validator
): validator is AsyncInputValidator
Parameters#
Name | Type |
---|---|
validator |
InputValidator <boolean > |
Returns#
validator is AsyncInputValidator
isSvg#
▸ isSvg(content
): boolean
Parameters#
Name | Type |
---|---|
content |
string |
Returns#
boolean
onMultiSelectFor#
▸ onMultiSelectFor<Value
, Option
, Group
>(collection
): SelectProps
<Value
, Option
, true
, Group
>["onChange"
]
Type parameters#
Name | Type |
---|---|
Value |
Value |
Option |
extends SelectOption <Value , Option > |
Group |
extends GroupBase <Option , Group > = GroupBase <Option > |
Parameters#
Name | Type |
---|---|
collection |
Set <Value > | ObservableSet <Value > |
Returns#
SelectProps
<Value
, Option
, true
, Group
>["onChange"
]
showDetails#
▸ showDetails(selfLink
, resetSelected?
): void
default
resetSelected true
Parameters#
Name | Type | Description |
---|---|---|
selfLink |
undefined | string |
The Kube selflink to show details for |
resetSelected? |
boolean |
If true then will reset the selected kube object (which object is highlighted generally) |
Returns#
void
unionInputValidatorsAsync#
▸ unionInputValidatorsAsync(baseValidator
, ...validators
): AsyncInputValidator
Create a new input validator from a list of syncronous or async input validators. Will match as valid if one of the input validators matches the input
Parameters#
Name | Type |
---|---|
baseValidator |
Simplify <Except <Pick <InputValidator <boolean >, "message" | "condition" >, "message" > & Required <Pick <Pick <InputValidator <boolean >, "message" | "condition" >, "message" >>> |
...validators |
InputValidator <boolean >[] |
Returns#
AsyncInputValidator
withTooltip#
▸ withTooltip<TargetProps
>(Target
): React.FunctionComponent
<TargetProps
& TooltipDecoratorProps
>
Type parameters#
Name |
---|
TargetProps |
Parameters#
Name | Type |
---|---|
Target |
TargetProps extends Pick <TooltipDecoratorProps , "children" | "id" > ? FunctionComponent <TargetProps > : never |
Returns#
React.FunctionComponent
<TargetProps
& TooltipDecoratorProps
>