API reference
Everything each package exports, generated from the source's doc comments.
| Package | |
|---|---|
@andamento/core | Patterns, createLayout, content placement, fills, hit testing, keyboard navigation and CSS helpers. No DOM. |
@andamento/svg | renderToString, renderToElement, renderToPng, drawLayout and SVG path helpers. |
@andamento/react | <TileLayout>, <SvgTileLayout> and hooks. |
@andamento/vue | <TileLayout>, <SvgTileLayout> and composables. |
@andamento/dom | mountTileLayout, <andamento-layout>, and the pieces the bindings share. |
Where to start
- Making a layout:
createLayout,LayoutOptions,Layout,Cell. - Patterns: the
TilingSpecunion and each pattern's spec, e.g.HexagonalSpec. - Content:
contentSlots,matchSlots,weightedLayout,fitCount. - Rendering:
RenderOptions, ReactTileLayoutProps,TileLayoutConfigformountTileLayout.