Skip to content

Namespace: Component#

Renderer.Component

Table of contents#

Enumerations#

Classes#

Interfaces#

Type Aliases#

Variables#

Functions#

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>: { condition?: (props: InputProps) => any } & IsAsync extends true ? { debounce: number ; message?: SyncValidationMessage ; validate: InputValidation<true> } : { debounce?: undefined ; message: SyncValidationMessage ; validate: InputValidation<false> }

Type parameters#

Name Type
IsAsync extends boolean = boolean

LegacyAutoConvertedOptions#

Ƭ LegacyAutoConvertedOptions: string[]

deprecated This should not be used anymore, convert the options yourself.


Ƭ 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


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#

Badge#

Const Badge: FunctionComponent<BadgeProps & TooltipDecoratorProps>


BarChart#

Const BarChart: FunctionComponent<BarChartProps>


Button#

Const Button: FunctionComponent<ButtonProps & TooltipDecoratorProps>


CommandOverlay#

Const CommandOverlay: CommandOverlay


ConfirmDialog#

Const ConfirmDialog: FunctionComponent<ConfirmDialogProps> & { confirm: Confirm ; open: OpenConfirmDialog }


Dialog#

Const Dialog: FunctionComponent<DialogProps>


Drawer#

Const Drawer: FunctionComponent<DrawerProps>


Icon#

Const Icon: FunctionComponent<IconProps & TooltipDecoratorProps> & { isSvg: (content: string) => boolean }


InputValidators#

InputValidators: Object

Type declaration#

Name Type
accountId InputValidator<false>
isEmail InputValidator<false>
isExtensionNameInstall InputValidator<false>
isExtensionNameInstallRegex { captures: (val: string) => undefined | { name: string ; version?: string } ; isMatch: (val: string) => boolean }
isExtensionNameInstallRegex.captures [object Object]
isExtensionNameInstallRegex.isMatch [object Object]
isNumber InputValidator<false>
isPath InputValidator<true>
isRequired InputValidator<false>
isUrl InputValidator<false>
maxLength InputValidator<false>
minLength InputValidator<false>
systemName InputValidator<false>
unionInputValidators (baseValidator: Pick<InputValidator<false>, "condition" | "message">, ...validators: InputValidator<false>[]) => InputValidator<false>

KubeEventDetails#

Const KubeEventDetails: FunctionComponent<KubeEventDetailsProps>


KubeObjectDetails#

Const KubeObjectDetails: FunctionComponent<{}>


KubeObjectMeta#

Const KubeObjectMeta: FunctionComponent<KubeObjectMetaProps>


LineProgress#

Const LineProgress: FunctionComponent<LineProgressProps & TooltipDecoratorProps>


MainLayout#

Const MainLayout: FunctionComponent<MainLayoutProps>


Const MenuActions: FunctionComponent<MenuActionsProps>


Const MenuContext: Context<null | Menu>


MonacoEditor#

Const MonacoEditor: ForwardRefExoticComponent<MonacoEditorProps & RefAttributes<MonacoEditorRef>>


NamespaceSelectFilter#

Const NamespaceSelectFilter: FunctionComponent<NamespaceSelectFilterProps>


Notifications#

Const Notifications: FC<{}> & { checkedError: (message: unknown, fallback: string, customOpts?: Partial<Omit<Notification, "message">>) => () => void ; error: (message: NotificationMessage, customOpts?: Partial<Omit<Notification, "message">>) => () => void ; info: (message: NotificationMessage, customOpts?: Partial<Omit<Notification, "message">>) => () => void ; ok: (message: NotificationMessage) => () => void ; shortInfo: (message: NotificationMessage, customOpts?: Partial<Omit<Notification, "message">>) => () => void }


PieChart#

Const PieChart: FunctionComponent<PieChartProps>


StatusBrick#

Const StatusBrick: FunctionComponent<StatusBrickProps & TooltipDecoratorProps>


Switcher#

Const Switcher: ComponentType<Pick<SwitcherProps, "id" | "name" | "prefix" | "defaultValue" | "className" | "form" | "slot" | "style" | "title" | "ref" | "autoFocus" | "readOnly" | "value" | "onChange" | "onError" | "innerRef" | "size" | "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" | "hidden" | "disabled" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "type" | "defaultChecked" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "contentEditable" | "contextMenu" | "dir" | "draggable" | "aria-errormessage" | "aria-invalid" | "aria-label" | "aria-labelledby" | "aria-live" | "placeholder" | "tabIndex" | "color" | "lang" | "role" | "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-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-keyshortcuts" | "aria-level" | "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" | "key" | "spellCheck" | "translate" | "radioGroup" | "about" | "datatype" | "inlist" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "action" | "checked" | "required" | "checkedIcon" | "icon" | "disableFocusRipple" | "edge" | "buttonRef" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "onFocusVisible" | "TouchRippleProps" | "inputProps" | "inputRef"> & StyledComponentProps<"track" | "root" | "thumb" | "focusVisible" | "checked" | "switchBase">>

deprecated Use instead from "../switch.tsx".


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


resizingAnchorProps#

Const resizingAnchorProps: Record<DrawerPosition, [ResizeDirection, ResizeSide, ResizeGrowthDirection]>


terminalStore#

Const terminalStore: TerminalStore & { sendCommand: (command: string, options: SendCommandOptions) => Promise<void> }

Functions#

Checkbox#

Checkbox(__namedParameters): Element

Parameters#

Name Type
__namedParameters CheckboxProps

Returns#

Element


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 instead from "../switch.tsx".

Parameters#

Name Type
props FormControlLabelProps

Returns#

Element


KubeObjectListLayout#

KubeObjectListLayout<K, A, D>(props): ReactElement<any, string | JSXElementConstructor<any>>

Type parameters#

Name Type
K extends KubeObject<unknown, unknown, KubeObjectScope, 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<unknown, unknown, KubeObjectScope, T>

Parameters#

Name Type
props KubeObjectMenuProps<T>

Returns#

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


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>>


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): InputValidator<true>

Parameters#

Name Type
validator InputValidator<true>

Returns#

InputValidator<true>


createTerminalTab#

createTerminalTab(tabParams?): Required<DockTabCreate>

Parameters#

Name Type
tabParams DockTabCreateSpecific

Returns#

Required<DockTabCreate>


getDetailsUrl#

getDetailsUrl(selfLink, resetSelected?, mergeGlobals?): string

deprecated use di.inject(getDetailsUrlInjectable) instead

Parameters#

Name Type
selfLink string
resetSelected? boolean
mergeGlobals? boolean

Returns#

string


inputValidator#

inputValidator(validator): InputValidator<false>

Parameters#

Name Type
validator InputValidator<false>

Returns#

InputValidator<false>


isAsyncValidator#

isAsyncValidator(validator): validator is InputValidator<true>

Parameters#

Name Type
validator InputValidator<boolean>

Returns#

validator is InputValidator<true>


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

deprecated use di.inject(showDetailsInjectable) instead

Parameters#

Name Type
selfLink undefined | string
resetSelected? boolean

Returns#

void


unionInputValidatorsAsync#

unionInputValidatorsAsync(baseValidator, ...validators): InputValidator<true>

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>, "condition" | "message">, "message"> & Required<Pick<Pick<InputValidator<boolean>, "condition" | "message">, "message">>>
...validators InputValidator<boolean>[]

Returns#

InputValidator<true>


withTooltip#

withTooltip<TargetProps>(Target): React.FunctionComponent<TargetProps & TooltipDecoratorProps>

Type parameters#

Name
TargetProps

Parameters#

Name Type
Target TargetProps extends Pick<TooltipDecoratorProps, "id" | "children"> ? FunctionComponent<TargetProps> : never

Returns#

React.FunctionComponent<TargetProps & TooltipDecoratorProps>