Module: "renderer-api/components"#
Index#
Enumerations#
Classes#
- Badge
- BarChart
- Button
- Checkbox
- CommandOverlay
- ConfirmDialog
- CubeSpinner
- Dialog
- Drawer
- DrawerItem
- DrawerParamToggler
- DrawerTitle
- Icon
- Input
- KubeEventDetails
- KubeObjectDetails
- KubeObjectListLayout
- KubeObjectMenu
- KubeObjectMeta
- LineProgress
- Menu
- MenuActions
- MenuItem
- NamespaceSelect
- NamespaceSelectFilter
- Notifications
- NotificationsStore
- PageLayout
- PieChart
- PodDetailsList
- Radio
- RadioGroup
- SearchInput
- Select
- Slider
- Spinner
- StatusBrick
- Stepper
- SubTitle
- Tab
- Table
- TableCell
- TableHead
- TableRow
- Tabs
- Tooltip
- Wizard
- WizardLayout
- WizardStep
Interfaces#
- BadgeProps
- ButtonProps
- CheckboxProps
- ConfirmDialogBooleanParams
- ConfirmDialogParams
- ConfirmDialogProps
- CubeSpinnerProps
- DialogProps
- DrawerItemLabelsProps
- DrawerItemProps
- DrawerParamTogglerProps
- DrawerProps
- DrawerTitleProps
- GroupSelectOption
- IconProps
- InputValidator
- KubeEventDetailsProps
- KubeObjectDetailsProps
- KubeObjectListLayoutProps
- KubeObjectMenuProps
- KubeObjectMetaProps
- LineProgressProps
- MenuActionsProps
- MenuItemProps
- MenuPosition
- MenuProps
- Notification
- PageLayoutProps
- RadioGroupProps
- SelectOption
- SelectProps
- SliderProps
- SpinnerProps
- StatusBrickProps
- StepperProps
- TabLayoutProps
- TabLayoutRoute
- TabProps
- TableCellProps
- TableHeadProps
- TableProps
- TableRowProps
- TabsProps
- TooltipContentFormatters
- TooltipDecoratorProps
- TooltipProps
- WizardLayoutProps
- WizardProps
- WizardStepProps
Type aliases#
- InputProps
- MenuContextValue
- NotificationId
- NotificationMessage
- RadioProps
- TableCellElem
- TableHeadElem
- TableOrderBy
- TableRowElem
- TableSortBy
- TableSortCallback
- TableSortCallbacks
- TableSortParams
Variables#
- InputValidators
- MenuContext
- Switcher
- TabLayout
- kubeDetailsUrlParam
- kubeSelectedUrlParam
- logTabStore
- notificationsStore
- orderByUrlParam
- sortByUrlParam
- terminalStore
Functions#
- DrawerItemLabels
- FormSwitch
- SubMenu
- createTerminalTab
- getDetailsUrl
- hideDetails
- showDetails
- withTooltip
Object literals#
Type aliases#
InputProps#
Ƭ InputProps: Omit‹InputElementProps, "onChange" | "onSubmit"› & object
Defined in src/renderer/components/input/input.tsx:43
MenuContextValue#
Ƭ MenuContextValue: Menu
Defined in src/renderer/components/menu/menu.tsx:31
NotificationId#
Ƭ NotificationId: string | number
Defined in src/renderer/components/notifications/notifications.store.tsx:28
NotificationMessage#
Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed
Defined in src/renderer/components/notifications/notifications.store.tsx:29
RadioProps#
Ƭ RadioProps: HTMLProps‹any› & object
Defined in src/renderer/components/radio/radio.tsx:61
TableCellElem#
Ƭ TableCellElem: ReactElement‹TableCellProps›
Defined in src/renderer/components/table/table-cell.tsx:30
TableHeadElem#
Ƭ TableHeadElem: ReactElement‹TableHeadProps›
Defined in src/renderer/components/table/table-head.tsx:27
TableOrderBy#
Ƭ TableOrderBy: "asc" | "desc" | string
Defined in src/renderer/components/table/table.tsx:38
TableRowElem#
Ƭ TableRowElem: ReactElement‹TableRowProps›
Defined in src/renderer/components/table/table-row.tsx:28
TableSortBy#
Ƭ TableSortBy: string
Defined in src/renderer/components/table/table.tsx:37
TableSortCallback#
Ƭ TableSortCallback: function
Defined in src/renderer/components/table/table.tsx:40
Type declaration:#
▸ (data: D): string | number | (string | number)[]
Parameters:
| Name | Type |
|---|---|
data |
D |
TableSortCallbacks#
Ƭ TableSortCallbacks: object
Defined in src/renderer/components/table/table.tsx:41
Type declaration:#
- [ columnId: string]: TableSortCallback
TableSortParams#
Ƭ TableSortParams: object
Defined in src/renderer/components/table/table.tsx:39
Type declaration:#
-
orderBy: TableOrderBy
-
sortBy: TableSortBy
Variables#
InputValidators#
• InputValidators: InputValidators
Defined in src/renderer/components/input/input.tsx:35
Const MenuContext#
• MenuContext: Context‹Menu‹›› = React.createContext
Defined in src/renderer/components/menu/menu.tsx:30
Const Switcher#
• Switcher: ComponentClass‹object & StyledComponentProps‹"track" | "root" | "thumb" | "focusVisible" | "switchBase" | "checked"›, any› | FunctionComponent‹object & StyledComponentProps‹"track" | "root" | "thumb" | "focusVisible" | "switchBase" | "checked"›› = withStyles((theme: Theme) =>
createStyles({
root: {
width: 40,
height: 24,
padding: 0,
margin: "0 0 0 8px",
},
switchBase: {
padding: 1,
paddingLeft: 4,
"&$checked": {
transform: "translateX(14px)",
color: "white",
"& + $track": {
backgroundColor: "#52d869",
opacity: 1,
border: "none",
},
},
"&$focusVisible $thumb": {
color: "#52d869",
border: "6px solid #fff",
},
},
thumb: {
width: 18,
height: 18,
marginTop: 2,
boxShadow: "none"
},
track: {
borderRadius: 26 / 2,
backgroundColor: "#72767b",
opacity: 1,
transition: theme.transitions.create(["background-color", "border"]),
},
checked: {},
focusVisible: {},
}),
)(({ classes, ...props }: Props) => {
return (
Defined in src/renderer/components/switch/switcher.tsx:34
Const TabLayout#
• TabLayout: (Anonymous function) = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => { const currentLocation = navigation.location.pathname; const hasTabs = tabs.length > 0; const startTabUrl = hasTabs ? (tabs.find(tab => tab.default) || tabs[0])?.url : null;
return (
return <Tab key={url} label={title} value={url} active={isActive}/>;
})}
</Tabs>
)}
<main className={cssNames(contentClass)}>
<ErrorBoundary>
{hasTabs && (
<Switch>
{tabs.map(({ routePath, exact, component }) => {
return <Route key={routePath} exact={exact} path={routePath} component={component}/>;
})}
<Redirect to={startTabUrl}/>
</Switch>
)}
{children}
</ErrorBoundary>
</main>
</div>
); })
Defined in src/renderer/components/layout/tab-layout.tsx:48
Const kubeDetailsUrlParam#
• kubeDetailsUrlParam: PageParam‹string› = createPageParam({ name: "kube-details", })
Defined in src/renderer/components/kube-object/kube-object-details.tsx:40
Used to store object.selfLink to show more info about resource in the details panel.
Const kubeSelectedUrlParam#
• kubeSelectedUrlParam: PageParam‹string› = createPageParam({ name: "kube-selected", get defaultValue() { return kubeDetailsUrlParam.get(); } })
Defined in src/renderer/components/kube-object/kube-object-details.tsx:51
Used to highlight last active/selected table row with the resource.
example
If we go to "Nodes (page) -> Node (details) -> Pod (details)",
last clicked Node should be "active" while Pod details are shown).
Const logTabStore#
• logTabStore: LogTabStore‹› = new LogTabStore()
Defined in src/renderer/components/dock/log-tab.store.ts:140
Const notificationsStore#
• notificationsStore: NotificationsStore‹› = new NotificationsStore()
Defined in src/renderer/components/notifications/notifications.store.tsx:103
Const orderByUrlParam#
• orderByUrlParam: PageParam‹string› = createPageParam({ name: "order", })
Defined in src/renderer/components/table/table.tsx:72
Const sortByUrlParam#
• sortByUrlParam: PageParam‹string› = createPageParam({ name: "sort", })
Defined in src/renderer/components/table/table.tsx:68
Const terminalStore#
• terminalStore: TerminalStore‹› = new TerminalStore()
Defined in src/renderer/components/dock/terminal.store.ts:132
Functions#
DrawerItemLabels#
▸ DrawerItemLabels(props: DrawerItemLabelsProps): Element‹›
Defined in src/renderer/components/drawer/drawer-item-labels.tsx:30
Parameters:
| Name | Type |
|---|---|
props |
DrawerItemLabelsProps |
Returns: Element‹›
FormSwitch#
▸ FormSwitch(props: FormControlLabelProps): Element‹›
Defined in src/renderer/components/switch/form-switcher.tsx:38
Parameters:
| Name | Type |
|---|---|
props |
FormControlLabelProps |
Returns: Element‹›
SubMenu#
▸ SubMenu(props: Partial‹MenuProps›): Element‹›
Defined in src/renderer/components/menu/menu.tsx:319
Parameters:
| Name | Type |
|---|---|
props |
Partial‹MenuProps› |
Returns: Element‹›
createTerminalTab#
▸ createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab
Defined in src/renderer/components/dock/terminal.store.ts:33
Parameters:
| Name | Type | Default |
|---|---|---|
tabParams |
Partial‹ITerminalTab› | {} |
Returns: IDockTab
getDetailsUrl#
▸ getDetailsUrl(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string
Defined in src/renderer/components/kube-object/kube-object-details.tsx:68
Parameters:
| Name | Type | Default |
|---|---|---|
selfLink |
string | - |
resetSelected |
boolean | false |
mergeGlobals |
boolean | true |
Returns: string
hideDetails#
▸ hideDetails(): void
Defined in src/renderer/components/kube-object/kube-object-details.tsx:64
Returns: void
showDetails#
▸ showDetails(selfLink: string, resetSelected: boolean): void
Defined in src/renderer/components/kube-object/kube-object-details.tsx:58
Parameters:
| Name | Type | Default |
|---|---|---|
selfLink |
string | "" |
resetSelected |
boolean | true |
Returns: void
withTooltip#
▸ withTooltip‹T›(Target: T): T
Defined in src/renderer/components/tooltip/withTooltip.tsx:39
Type parameters:
▪ T: React.ComponentType‹any›
Parameters:
| Name | Type |
|---|---|
Target |
T |
Returns: T
Object literals#
Const cpuOptions#
▪ cpuOptions: object#
Defined in src/renderer/components/chart/bar-chart.tsx:220
▪ scales: object
Defined in src/renderer/components/chart/bar-chart.tsx:221
- yAxes: object[] = [{
ticks: {
callback: (value: number | string): string => {
const float = parseFloat(
${value});if (float == 0) return "0"; if (float < 10) return float.toFixed(3); if (float < 100) return float.toFixed(2); return float.toFixed(1); }} }]
▪ tooltips: object
Defined in src/renderer/components/chart/bar-chart.tsx:236
-
callbacks: object
-
label(
__namedParameters: object,__namedParameters: object): string
Const memoryOptions#
▪ memoryOptions: object#
Defined in src/renderer/components/chart/bar-chart.tsx:186
▪ scales: object
Defined in src/renderer/components/chart/bar-chart.tsx:187
- yAxes: object[] = [{
ticks: {
callback: (value: number | string): string => {
if (typeof value == "string") {
const float = parseFloat(value);
if (float < 1) { return float.toFixed(3); } return bytesToUnits(parseInt(value)); } return bytesToUnits(value); }, stepSize: 1} }]
▪ tooltips: object
Defined in src/renderer/components/chart/bar-chart.tsx:207
-
callbacks: object
-
label(
__namedParameters: object,__namedParameters: object): string