Class: AndamentoLayoutElement
<andamento-layout>: a tiling as a web component, for any framework or none (Angular, Svelte, Solid, Lit, plain HTML). Each child element fills one tile, in reading order, clipped to the tile's shape; children stay where you put them (they're shown in the tiles through slots), so frameworks keep managing them.
Set options (a LayoutOptions object, or JSON in the attribute) or layout. Simple settings are attributes too: navigable, animate, relief, safe-area, virtualize, fit, placement, content-cells, choose, background, fill, focus-ring, label. Give children data-aspect (width / height) to put them in tiles of their shape, and data-focus ("x y", fractions of the width and height) to keep that point of a photo in view as its tile crops it (style the photo with coverStyle, or object-position: var(--andamento-object-position)), and data-weight (how many tiles it spans) to give important children featured tiles. A child with slot="backdrop" is copied into every tile as one picture across them all.
Tiles are in the element's shadow root: style them with ::part(tile) (also empty and boundary, e.g. andamento-layout::part(empty)). Activating a tile fires cellactivate, with CellActivateDetail.
Extends
Base
Constructors
Constructor
new AndamentoLayoutElement(): AndamentoLayoutElement;Returns
AndamentoLayoutElement
Overrides
Base.constructorProperties
observedAttributes
static observedAttributes: string[] = ATTRIBUTES;Accessors
animated
Get Signature
get animated():
| boolean
| {
duration?: number;
easing?: string;
}
| undefined;Animate changes (the animate attribute; animate itself is the Web Animations method).
Returns
| boolean | { duration?: number; easing?: string; } | undefined
Set Signature
set animated(v): void;Parameters
| Parameter | Type |
|---|---|
v | | boolean | { duration?: number; easing?: string; } | undefined |
Returns
void
aspects
Get Signature
get aspects(): readonly number[] | undefined;Width / height of each child; otherwise read from children's data-aspect.
Returns
readonly number[] | undefined
Set Signature
set aspects(v): void;Parameters
| Parameter | Type |
|---|---|
v | readonly number[] | undefined |
Returns
void
background
Get Signature
get background(): string | undefined;Returns
string | undefined
Set Signature
set background(v): void;Parameters
| Parameter | Type |
|---|---|
v | string | undefined |
Returns
void
cellLabel
Get Signature
get cellLabel(): PerCell<string | undefined>;Accessible name of each tile.
Returns
PerCell<string | undefined>
Set Signature
set cellLabel(v): void;Parameters
| Parameter | Type |
|---|---|
v | PerCell<string | undefined> |
Returns
void
cellStyle
Get Signature
get cellStyle(): PerCell<StyleMap | undefined>;Extra style for each tile.
Returns
Set Signature
set cellStyle(v): void;Parameters
| Parameter | Type |
|---|---|
v | PerCell<StyleMap | undefined> |
Returns
void
choose
Get Signature
get choose(): "placement" | "shape" | undefined;Returns
"placement" | "shape" | undefined
Set Signature
set choose(v): void;Parameters
| Parameter | Type |
|---|---|
v | "placement" | "shape" | undefined |
Returns
void
contentCells
Get Signature
get contentCells(): ContentCells | undefined;Returns
ContentCells | undefined
Set Signature
set contentCells(v): void;Parameters
| Parameter | Type |
|---|---|
v | ContentCells | undefined |
Returns
void
fallback
Get Signature
get fallback(): PerCell<TileContent>;Content for empty tiles (rendered in the shadow root).
Returns
Set Signature
set fallback(v): void;Parameters
| Parameter | Type |
|---|---|
v | PerCell<TileContent> |
Returns
void
fill
Get Signature
get fill(): FillSource | undefined;Color of empty tiles: a color, a palette or a function per cell.
Returns
FillSource | undefined
Set Signature
set fill(v): void;Parameters
| Parameter | Type |
|---|---|
v | FillSource | undefined |
Returns
void
fit
Get Signature
get fit(): FitProp | undefined;Returns
FitProp | undefined
Set Signature
set fit(v): void;Parameters
| Parameter | Type |
|---|---|
v | FitProp | undefined |
Returns
void
focalPoints
Get Signature
get focalPoints():
| readonly (Focus | undefined)[]
| undefined;Focal point of each child; otherwise read from children's data-focus.
Returns
| readonly (Focus | undefined)[] | undefined
Set Signature
set focalPoints(v): void;Parameters
| Parameter | Type |
|---|---|
v | | readonly (Focus | undefined)[] | undefined |
Returns
void
focusRing
Get Signature
get focusRing(): string | false | undefined;Returns
string | false | undefined
Set Signature
set focusRing(v): void;Parameters
| Parameter | Type |
|---|---|
v | string | false | undefined |
Returns
void
layout
Get Signature
get layout(): Layout | undefined;A precomputed layout, instead of options.
Returns
Layout | undefined
Set Signature
set layout(v): void;Parameters
| Parameter | Type |
|---|---|
v | Layout | undefined |
Returns
void
navigable
Get Signature
get navigable(): boolean | undefined;Returns
boolean | undefined
Set Signature
set navigable(v): void;Parameters
| Parameter | Type |
|---|---|
v | boolean | undefined |
Returns
void
options
Get Signature
get options(): LayoutOptions | undefined;Layout options (also the options attribute, as JSON).
Returns
LayoutOptions | undefined
Set Signature
set options(v): void;Parameters
| Parameter | Type |
|---|---|
v | LayoutOptions | undefined |
Returns
void
placement
Get Signature
get placement():
| ContentPlacement
| undefined;Returns
| ContentPlacement | undefined
Set Signature
set placement(v): void;Parameters
| Parameter | Type |
|---|---|
v | | ContentPlacement | undefined |
Returns
void
relief
Get Signature
get relief(): boolean | ReliefOptions | undefined;Returns
boolean | ReliefOptions | undefined
Set Signature
set relief(v): void;Parameters
| Parameter | Type |
|---|---|
v | boolean | ReliefOptions | undefined |
Returns
void
safeArea
Get Signature
get safeArea(): SafeAreaProp | undefined;Returns
SafeAreaProp | undefined
Set Signature
set safeArea(v): void;Parameters
| Parameter | Type |
|---|---|
v | SafeAreaProp | undefined |
Returns
void
virtualize
Get Signature
get virtualize():
| boolean
| {
overscan?: number;
}
| undefined;Returns
| boolean | { overscan?: number; } | undefined
Set Signature
set virtualize(v): void;Parameters
| Parameter | Type |
|---|---|
v | | boolean | { overscan?: number; } | undefined |
Returns
void
weights
Get Signature
get weights(): readonly number[] | undefined;Tiles each child spans; otherwise read from children's data-weight.
Returns
readonly number[] | undefined
Set Signature
set weights(v): void;Parameters
| Parameter | Type |
|---|---|
v | readonly number[] | undefined |
Returns
void
Methods
attributeChangedCallback()
attributeChangedCallback(): void;Returns
void
connectedCallback()
connectedCallback(): void;Returns
void
disconnectedCallback()
disconnectedCallback(): void;Returns
void
render()
render(): void;Render now rather than at the end of the current task (e.g. before measuring).
Returns
void
tileElement()
tileElement(cellId): HTMLElement | undefined;The tile element (in the shadow root) showing a cell, if it's rendered.
Parameters
| Parameter | Type |
|---|---|
cellId | string |
Returns
HTMLElement | undefined