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

    Interface LayoutResult<TId, TMeta>

    interface LayoutResult<TId extends string = string, TMeta = unknown> {
        affordances: Affordance<TMeta>[];
        isPreview?: boolean;
        placements: Map<TId, Rect>;
        unplaced?: TId[];
    }

    Type Parameters

    • TId extends string = string
    • TMeta = unknown
    Index

    Properties

    affordances: Affordance<TMeta>[]
    isPreview?: boolean

    True when this result was produced in response to a preview input and the strategy honored it. <Container> uses this to know whether to suppress the source's real chrome (it's rendered as the ghost instead).

    placements: Map<TId, Rect>
    unplaced?: TId[]

    Items the strategy chose not to place (e.g. grid overflow when capacity is capped). Consumers may render these in an overflow tray or hide them.