Circle V2 API Docs
    Preparing search index...

    Interface RootBaseProps

    interface RootBaseProps {
        asChild?: boolean;
        defaultSize?: number[];
        id?: string;
        ids?: Partial<
            {
                label: (id: string) => string;
                panel: (id: string | number) => string;
                resizeTrigger: (id: string) => string;
                root: string;
            },
        >;
        keyboardResizeBy?: number
        | null;
        nonce?: string;
        onCollapse?: (details: ExpandCollapseDetails) => void;
        onExpand?: (details: ExpandCollapseDetails) => void;
        onResize?: (details: ResizeDetails) => void;
        onResizeEnd?: (details: ResizeEndDetails) => void;
        onResizeStart?: () => void;
        orientation?: "horizontal" | "vertical";
        panels: PanelData[];
        recipe?: SlotRecipeDefinition<string, SlotRecipeVariantRecord<string>>;
        size?: number[];
        unstyled?: boolean;
    }

    Hierarchy

    • Assign<ArkSplitter.RootBaseProps, SlotRecipeProps<"splitter">>
    • UnstyledProp
      • RootBaseProps
    Index

    Properties

    asChild? defaultSize? id? ids? keyboardResizeBy? nonce? onCollapse? onExpand? onResize? onResizeEnd? onResizeStart? orientation? panels recipe? size? unstyled?

    Properties

    asChild?: boolean

    Use the provided child element as the default rendered element, combining their props and behavior.

    defaultSize?: number[]

    The initial size of the panels when rendered. Use when you don't need to control the size of the panels.

    id?: string

    The unique identifier of the machine.

    ids?: Partial<
        {
            label: (id: string) => string;
            panel: (id: string | number) => string;
            resizeTrigger: (id: string) => string;
            root: string;
        },
    >

    The ids of the elements in the splitter. Useful for composition.

    keyboardResizeBy?: number | null

    The number of pixels to resize the panel by when the keyboard is used.

    nonce?: string

    The nonce for the injected splitter cursor stylesheet.

    onCollapse?: (details: ExpandCollapseDetails) => void

    Function called when a panel is collapsed.

    onExpand?: (details: ExpandCollapseDetails) => void

    Function called when a panel is expanded.

    onResize?: (details: ResizeDetails) => void

    Function called when the splitter is resized.

    onResizeEnd?: (details: ResizeEndDetails) => void

    Function called when the splitter resize ends.

    onResizeStart?: () => void

    Function called when the splitter resize starts.

    orientation?: "horizontal" | "vertical"

    The orientation of the splitter. Can be horizontal or vertical

    "horizontal"
    panels: PanelData[]

    The size constraints of the panels.

    recipe?: SlotRecipeDefinition<string, SlotRecipeVariantRecord<string>>
    size?: number[]

    The controlled size data of the panels

    unstyled?: boolean

    If true, the element will opt out of the theme styles.

    Settings

    Member Visibility

    On This Page

    Properties