Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrTileManager

The tile manager component enables the dynamic arrangement, resizing, and interaction of tiles.

Slot

  • Default slot for the tile manager. Only igc-tile elements will be projected inside the CSS grid container.

Csspart

base - The tile manager CSS Grid container.

Cssproperty

--column-count - The number of columns for the tile manager. The column-count attribute sets this variable.

Cssproperty

--min-col-width - The minimum size of the columns in the tile-manager. The min-column-width attribute sets this variable.

Cssproperty

--min-row-height - The minimum size of the rows in the tile-manager. The min-row-height attribute sets this variable.

Cssproperty

--grid-gap - The gap size of the underlying CSS grid container. The gap attributes sts this variable.

Callable

  • IgrTileManager(): ReactNode

    Returns ReactNode

Accessors

Events

Methods

Properties

Accessors

tiles

tiles: IgrTile[]

Gets the tiles sorted by their position in the layout.

Events

onTileDragCancel

onTileDragCancel: (args: CustomEvent<IgrTile>) => void

Type declaration

onTileDragEnd

onTileDragEnd: (args: CustomEvent<IgrTile>) => void

Type declaration

onTileDragStart

onTileDragStart: (args: CustomEvent<IgrTile>) => void

Type declaration

onTileFullscreen

onTileFullscreen: (args: CustomEvent<IgrTileChangeStateEventArgsDetail>) => void

Type declaration

onTileMaximize

onTileMaximize: (args: CustomEvent<IgrTileChangeStateEventArgsDetail>) => void

Type declaration

onTileResizeCancel

onTileResizeCancel: (args: CustomEvent<IgrTile>) => void

Type declaration

onTileResizeEnd

onTileResizeEnd: (args: CustomEvent<IgrTile>) => void

Type declaration

onTileResizeStart

onTileResizeStart: (args: CustomEvent<IgrTile>) => void

Type declaration

Methods

loadLayout

  • loadLayout(data: string): void

    Restores a previously serialized state produced by saveLayout.

    Parameters

    • data: string

    Returns void

saveLayout

  • saveLayout(): string

    Returns the properties of the current tile collections as a JSON payload.

    Remarks

    The content of the tiles is not serialized or saved. Only tile properties are serialized.

    Returns string

Properties

columnCount

columnCount: number

Sets the number of columns for the tile manager. Setting value <= than zero will trigger a responsive layout.

dragMode

dragMode: TileManagerDragMode

Whether drag and drop operations are enabled.

gap

gap: string

Sets the gap size between tiles in the tile manager.

minColumnWidth

minColumnWidth: string

Sets the minimum width for a column unit in the tile manager.

minRowHeight

minRowHeight: string

Sets the minimum height for a row unit in the tile manager.

resizeMode

resizeMode: TileManagerResizeMode

Whether resize operations are enabled.