windease API reference - v0.6.0
    Preparing search index...

    Interface ZoneProps

    interface ZoneProps {
        acceptsDrops?: boolean;
        affordances?: boolean;
        children?: ReactNode;
        className?: string;
        config?: unknown;
        "data-testid"?: string;
        hidden?: boolean;
        id?: NodeId;
        meta?: Record<string, unknown>;
        order?: number;
        parentId?: NodeId;
        placement?: Record<string, unknown>;
        renderImperative?: (node: Node) => ReactNode;
        settleMs?: number;
        sort?: ChildSort;
        state?: unknown;
        strategyId?: string;
        style?: CSSProperties;
        title?: ReactNode;
        viewport?: { h: number; w: number };
    }

    Hierarchy

    • CommonBindingProps
    • PresentationalProps
      • ZoneProps
    Index

    Properties

    acceptsDrops? affordances? children? className? config? data-testid? hidden? id? meta? order? parentId? placement? renderImperative? settleMs? sort? state? strategyId? style? title? viewport?

    Properties

    acceptsDrops?: boolean

    When true, registers this preset's wrapper element as a drop target so consumers can drag items into it. The element must have a container capability (Zone and Group always do; Panel needs the container prop).

    affordances?: boolean

    Reserved for parity with the store-driven Container. Not yet wired through to a renderer in the declarative path.

    children?: ReactNode
    className?: string
    config?: unknown
    "data-testid"?: string
    hidden?: boolean
    id?: NodeId
    meta?: Record<string, unknown>
    order?: number
    parentId?: NodeId
    placement?: Record<string, unknown>
    renderImperative?: (node: Node) => ReactNode

    Optional renderer for children that exist in the store but were NOT declared as JSX siblings (i.e. added imperatively via store.registerNode). Receives the node; the returned ReactNode is wrapped in an absolute-positioned box at the strategy-computed rect. When omitted, imperative-only children still occupy a strategy slot but render no DOM — preserves previous behavior.

    settleMs?: number

    Settle animation duration in ms for children moving between strategy-computed placements. Default 150. Set to 0 to disable.

    sort?: ChildSort
    state?: unknown
    strategyId?: string
    style?: CSSProperties
    title?: ReactNode
    viewport?: { h: number; w: number }

    Settings

    Member Visibility

    On This Page

    Properties