ReferenceComponentsLayout and panes
ResizablePaneProps
ResizablePaneProps component contract.
Type
export interface ResizablePaneProps
extends CommonComponentProps,
SlottedComponentProps<
ResizablePaneSlots,
{ readonly focused: boolean; readonly size: number }
> {
readonly children?: ReactNode;
readonly direction?: "horizontal" | "vertical";
readonly extent?: number;
readonly defaultExtent?: number;
readonly minSize?: number;
readonly maxSize?: number;
readonly resizeStep?: number;
readonly onSizeChange?: (size: number) => void | Promise<void>;
readonly autoFocus?: boolean;
}Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
children | ReactNode | No | The children member uses the ReactNode contract. | — |
direction | "horizontal" | "vertical" | undefined | No | The direction member uses the "horizontal" | "vertical" | undefined contract. | — |
extent | number | undefined | No | The extent member uses the number | undefined contract. | — |
defaultExtent | number | undefined | No | The defaultExtent member uses the number | undefined contract. | — |
minSize | number | undefined | No | The minSize member uses the number | undefined contract. | — |
maxSize | number | undefined | No | The maxSize member uses the number | undefined contract. | — |
resizeStep | number | undefined | No | The resizeStep member uses the number | undefined contract. | — |
onSizeChange | ((size: number) => void | Promise<void>) | undefined | No | The onSizeChange member uses the ((size: number) => void | Promise<void>) | undefined contract. | — |
autoFocus | boolean | undefined | No | The autoFocus member uses the boolean | undefined contract. | — |
variant | string | undefined | No | The variant member uses the string | undefined contract. | — |
size | "sm" | "md" | "lg" | undefined | No | The size member uses the "sm" | "md" | "lg" | undefined contract. | — |
unstyled | boolean | undefined | No | The unstyled member uses the boolean | undefined contract. | — |
className | string | undefined | No | The className member uses the string | undefined contract. | — |
layout | Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined | No | The layout member uses the Partial<Omit<LayoutNodeInput, "children" | "id" | "semantics">> | undefined contract. | — |
id | string | undefined | No | The id member uses the string | undefined contract. | — |
testId | string | undefined | No | The testId member uses the string | undefined contract. | — |
role | SemanticRole | undefined | No | The role member uses the SemanticRole | undefined contract. | SemanticRole |
label | string | undefined | No | The label member uses the string | undefined contract. | — |
description | string | undefined | No | The description member uses the string | undefined contract. | — |
disabled | boolean | undefined | No | The disabled member uses the boolean | undefined contract. | — |
readOnly | boolean | undefined | No | The readOnly member uses the boolean | undefined contract. | — |
selected | boolean | undefined | No | The selected member uses the boolean | undefined contract. | — |
checked | boolean | undefined | No | The checked member uses the boolean | undefined contract. | — |
expanded | boolean | undefined | No | The expanded member uses the boolean | undefined contract. | — |
valueText | string | undefined | No | The valueText member uses the string | undefined contract. | — |
slots | Partial<SlotComponents<{ root: import("ink").BoxProps; content: import("ink").BoxProps; handle: import("ink").TextProps; }>> | undefined | No | The slots member uses the Partial<SlotComponents<{ root: import("ink").BoxProps; content: import("ink").BoxProps; handle: import("ink").TextProps; }>> | undefined contract. | BoxProps, SlotComponents, TextProps |
slotProps | Partial<SlotProps<{ root: import("ink").BoxProps; content: import("ink").BoxProps; handle: import("ink").TextProps; }, { readonly focused: boolean; readonly size: number; }>> | undefined | No | The slotProps member uses the Partial<SlotProps<{ root: import("ink").BoxProps; content: import("ink").BoxProps; handle: import("ink").TextProps; }, { readonly focused: boolean; readonly size: number; }>> | undefined contract. | BoxProps, SlotProps, TextProps |