Class Brique

Class representing a Brique.

Hierarchy

Brique

Constructors

constructor

new Brique(gridElement: HTMLElement, options?: BriqueOptions, observeGridResize?: boolean): Brique

- Defined in index.ts:33
Creates a new instance of Brique.

Parameters
- gridElement: HTMLElement
  
  Grid container
- options: BriqueOptions = Brique.DEFAULT_OPTIONS
  
  Options to customize the grid
- observeGridResize: boolean = true
  
  Update the dimension of grid items when the grid container is resized
Returns Brique

Properties

Private childrenObserver

childrenObserver: MutationObserver

Readonly gridElement

gridElement: HTMLElement

Optional itemElements

itemElements?: HTMLElement[]

Private observeGridResize

observeGridResize: boolean

Private options

options: BriqueOptions

Private resizeEvent

resizeEvent: () => void

Type declaration

- (): void
- Returns void

Private resizeObserver

resizeObserver: ResizeObserver

Static DEFAULT_OPTIONS

DEFAULT_OPTIONS: BriqueOptions = ...

Methods

destroy

destroy(): void

- Defined in index.ts:123
Removes all events listened to on the HTML elements handled by the Brique class. The destroy() method must be called when the grid is removed from HTML.

Returns void

Private draw

draw(): void

- Defined in index.ts:132
Apply inline styles on grid container and grid items

Returns void

Private drawGridContainer

drawGridContainer(): void

- Defined in index.ts:140
Apply inline styles on grid container

Returns void

Private drawItems

drawItems(): void

- Defined in index.ts:152
Apply inline styles on grid items

Returns void

getOptions

getOptions(): BriqueOptions

- Defined in index.ts:94
Return current options object.

Returns BriqueOptions

Private setItemElements

setItemElements(): void

- Defined in index.ts:178
Find grid items in grid element children and set property itemElements

Returns void

setOptions

setOptions(options: BriqueOptions): void

- Defined in index.ts:102
Change all properties of options object.

Parameters
- options: BriqueOptions
Returns void

stopUpdateOnResize

stopUpdateOnResize(): void

- Defined in index.ts:85
Update the dimension of grid items when the grid element is resized.

Returns void

update

update(): void

- Defined in index.ts:59
Update the rendering of the entire grid.

Returns void

updateItems

updateItems(): void

- Defined in index.ts:67
Update the rendering of the grid items.

Returns void

updateOnResize

updateOnResize(): void

- Defined in index.ts:75
Update the dimension of grid items when the grid element is resized.

Returns void

updateOptions

updateOptions(updatedOptions: BriqueOptions): void

- Defined in index.ts:111
Updates only changed properties.

Parameters
- updatedOptions: BriqueOptions
  
  Option properties to update
Returns void

Generated using TypeDoc