API Reference
Choose the Tilery API surface by the task your app is trying to complete.
Start with the task
The API reference is split by workflow. If you are wiring Tilery for the first time, start with component props. If you are saving a workspace, start with layouts and snapshots. If you are responding to user actions, start with events and callbacks.
| Task | Use this page | Why |
|---|---|---|
| Render a Tilery workspace | Component Props | Covers initialLayout, render functions, sizing props, built-in actions, and callbacks on the React component. |
| Author or persist a layout | Layouts & Snapshots | Covers group trees, panels, edge panels, floating panels, tab config, behavior flags, and snapshots. |
| Theme or override UI | Styling API | Covers CSS variables, stable selectors, data attributes, popout-safe styling, and hit target props. |
| Open, move, float, or rename tabs | Programmatic Control | Covers the controller ref plus panel and tab objects for runtime workflows. |
| Sync app state or analytics | Events & Callbacks | Covers resize events, lifecycle events, structural changes, and close/open payloads. |
Reference pages
- Component Props — Wire a Tilery component with an initial layout, tab renderers, behavior props, panel action controls, and lifecycle callbacks.
- Layouts & Snapshots — Build the serializable tree shape used for initial layouts, persistence, edge panels, floating panels, size constraints, and locking behavior.
- Styling API — Look up theme variables, class selectors, resize state attributes, popout styling rules, and styling-related props.
- Programmatic Control — Use the controller ref, panel objects, and tab objects to drive workspace workflows from your app.
- Events & Callbacks — Listen for resize, tab, panel, split, active-tab, open, close, and move events.
Reading the reference
The reference pages intentionally keep the wire shapes close to the explanation. Read the short guidance at the top of each section first, then use the tables and type blocks as lookup material while implementing.