@hydroperx/metro
    Preparing search index...

    Type Alias TilesParams

    type TilesParams = {
        click?: (id: string) => void;
        controller: TilesController;
        direction: "horizontal" | "vertical";
        drag?: (event: { button: HTMLButtonElement; id: string }) => void;
        dragEnabled?: boolean;
        dragEnd?: (event: { button: HTMLButtonElement; id: string }) => void;
        dragStart?: (event: { button: HTMLButtonElement; id: string }) => void;
        groupWidth?: number;
        inlineGroups?: number;
        open?: boolean;
        selectionChange?: (tiles: string[]) => void;
        selectionEnabled?: boolean;
        stateUpdated?: (state: TilesState) => void;
        style?: React.CSSProperties;
    }
    Index

    Properties

    click? controller direction drag? dragEnabled? dragEnd? dragStart? groupWidth? inlineGroups? open? selectionChange? selectionEnabled? stateUpdated? style?

    Properties

    click?: (id: string) => void

    Event that triggers when a tile is clicked.

    controller: TilesController

    The tile controller allows operations such as controlling which tiles are checked (selected) and their sizes.

    direction: "horizontal" | "vertical"

    Whether the live tiles layout is horizontal or vertical.

    drag?: (event: { button: HTMLButtonElement; id: string }) => void

    Event that triggers while a tile is dragging.

    dragEnabled?: boolean

    Whether drag-n-drop is enabled.

    true
    dragEnd?: (event: { button: HTMLButtonElement; id: string }) => void

    Event that triggers when a tile finishes dragging (drop).

    dragStart?: (event: { button: HTMLButtonElement; id: string }) => void

    Event that triggers when a tile starts dragging.

    groupWidth?: number

    Group width in small tiles unit (1x1), in case the container is vertical.

    inlineGroups?: number

    Number of inline groups in case the container is vertical.

    open?: boolean

    Whether to display open or close transition.

    A Tiles component displays a TILES_OPEN_DELAY milliseconds scale/opacity transition when visibility changes; this property indicats whether the container is open or closed.

    true
    selectionChange?: (tiles: string[]) => void

    Event that triggers when any tiles are checked or unchecked. The given tiles parameter contains the tiles that are currently checked.

    selectionEnabled?: boolean

    Whether tile selection/checking is enabled.

    true
    stateUpdated?: (state: TilesState) => void

    Event that triggers when the state is updated.

    style?: React.CSSProperties

    Settings

    Member Visibility

    On This Page

    Properties