# Azmara Platform

> TypeScript libraries for building web apps: a signals-based reactivity core and query layer, a database adapter contract with SQLite and Supabase adapters, security helpers, and `@azmr/ui`, a React component library built on Base UI and Tailwind v4 design tokens.

This file lists the documentation as Markdown pages that are easy for a coding assistant to read. Every page of https://platform.azmara.io/docs is also available as Markdown by adding `.md` to its address. [llms-full.txt](https://platform.azmara.io/llms-full.txt) has all of it in one file, including the props tables and the source of every example.

The components are React-only today. The core, query, security and database packages have no React dependency.

## Overview

- [Azmara Platform Docs](https://platform.azmara.io/docs/index.md): Documentation for the Azmara Platform packages.

## Guide

- [Introduction](https://platform.azmara.io/docs/guide/introduction.md): Azmara Platform is a modern, data-first application runtime where your data layer is a first-class citizen, not an afterthought.
- [Installation](https://platform.azmara.io/docs/guide/installation.md): Set up the Azmara Platform monorepo locally.
- [Playground](https://platform.azmara.io/docs/guide/playground.md): A live, interactive demo of @azmr/core, @azmr/query, and @azmr/ui working together.
- [Reactivity](https://platform.azmara.io/docs/guide/reactivity.md): Azmara's reactive system is built around three primitives — Signal, effect, and computed.
- [Data-First Philosophy](https://platform.azmara.io/docs/guide/data-first.md): Azmara is built around a single idea — your data layer should not be an external dependency, it should be the foundation.
- [Tailwind CSS setup](https://platform.azmara.io/docs/guide/tailwind.md): What @azmr/ui needs from Tailwind CSS v4, how Tailwind finds the package's classes, and why class names are spelled out in full.
- [Theming](https://platform.azmara.io/docs/guide/theming.md): Change the brand colours, switch between light and dark, set density, and see exactly what createTheme guarantees.
- [Customising components](https://platform.azmara.io/docs/guide/customising.md): Four ways to change how a component looks or behaves, from a className override to copying its source with the shadcn CLI.
- [Design tokens](https://platform.azmara.io/docs/guide/tokens.md): Every design token in @azmr/ui, with its light and dark values, the Tailwind utilities that use it, and the contrast it is tested against.
- [Accessibility](https://platform.azmara.io/docs/guide/accessibility.md): The accessibility target for @azmr/ui, what is tested automatically, what is not tested yet, and how to build accessible screens with it.
- [Accessibility reference](https://platform.azmara.io/docs/guide/accessibility-reference.md): Which components take keyboard input, every component's key map in one place, and what is checked for each page.

## Components

- [Components](https://platform.azmara.io/docs/components.md): The @azmr/ui component library, built on Base UI primitives and the Azmara design tokens.
- [Layout](https://platform.azmara.io/docs/components/layout.md): Stack, Grid with a responsive column count, Container, Separator and AspectRatio. All Server Components.
- [ScrollArea](https://platform.azmara.io/docs/components/scroll-area.md): A scrollable region with token-styled scrollbars that is keyboard-focusable and named. Built on Base UI.
- [Button](https://platform.azmara.io/docs/components/button.md): Triggers an action. Six variants, density-aware sizes, a loading state that keeps keyboard focus, and an icon-only form the types force you to name.
- [SplitButton](https://platform.azmara.io/docs/components/split-button.md): A primary action with a menu of related actions attached. Button plus DropdownMenu.
- [Input](https://platform.azmara.io/docs/components/input.md): A text input whose ref is the real input element, so react-hook-form works without a Controller.
- [Toggle](https://platform.azmara.io/docs/components/toggle.md): Toggle and ToggleGroup. A button that stays pressed, and a group of them that acts as one control with arrow-key navigation. Built on Base UI.
- [Display](https://platform.azmara.io/docs/components/display.md): Card, Badge, Alert, Skeleton and EmptyState. Server Components with status colours checked for contrast in both themes.
- [Table](https://platform.azmara.io/docs/components/table.md): A semantic, non-interactive table with a caption, sticky header, striping and a named scroll region. Server-safe.
- [Avatar](https://platform.azmara.io/docs/components/avatar.md): A person or entity as an image with initials as the fallback, plus a group with a labelled overflow count. Built on Base UI.
- [Typography](https://platform.azmara.io/docs/components/typography.md): A type scale where the variant picks the semantic element, with Heading, Text, Link, Code and Kbd. All Server Components.
- [Icon](https://platform.azmara.io/docs/components/icon.md): Renders Lucide, Tabler or your own SVG with consistent size, stroke, motion and accessibility. A Server Component.
- [Disclosure](https://platform.azmara.io/docs/components/disclosure.md): Accordion, Collapsible and Tabs. Show and hide content with the keyboard maps users expect. Built on Base UI.
- [Progress](https://platform.azmara.io/docs/components/progress.md): A linear or circular progress indicator with a required name, a determinate and an indeterminate state, and tones that stay visible against the track.
- [Spinner](https://platform.azmara.io/docs/components/spinner.md): An indeterminate progress indicator that is a Server Component and keeps spinning under reduced motion.
- [Toast](https://platform.azmara.io/docs/components/toast.md): Short notifications raised from anywhere with toast.success(), toast.error() and toast.promise(). Stacked, pausable, swipeable and announced to screen readers. Built on Base UI.
- [Floating](https://platform.azmara.io/docs/components/floating.md): Tooltip, Popover and HoverCard. Surfaces anchored to a trigger, collision-aware, portalled, and animated with the motion tokens. Built on Base UI.
- [Modal](https://platform.azmara.io/docs/components/modal.md): Dialog, AlertDialog and Drawer. Surfaces that take over the screen, with a focus trap, an inert page, scroll lock and focus return. Built on Base UI.
- [Menu](https://platform.azmara.io/docs/components/menu.md): DropdownMenu and ContextMenu. Menus of actions with items, checkbox and radio items, groups and submenus. Built on Base UI.
- [Breadcrumb](https://platform.azmara.io/docs/components/breadcrumb.md): A trail showing where you are and the way back up. Built from parts or from data, collapsible, router-friendly. Server-safe.
- [Pagination](https://platform.azmara.io/docs/components/pagination.md): A page control that is real links on the server or buttons for client state, with a stable-width page range the data grid reuses. Server-safe.
- [Stepper](https://platform.azmara.io/docs/components/stepper.md): Shows where someone is in a fixed sequence of steps. A status display with each state said in text, horizontal or vertical. Server-safe.
- [Motion](https://platform.azmara.io/docs/components/motion.md): CSS-first motion presets driven by tokens, a Collapse that never measures height, a count-up, a ViewTransition wrapper, useReducedMotion and an optional module for the motion library. Reduced motion is built in.

## Examples

- [Examples](https://platform.azmara.io/docs/examples.md): Five complete screens built only from @azmr/ui, each live, keyboard-tested and with its full source.
- [Settings page](https://platform.azmara.io/docs/examples/settings-page.md): A form that validates on submit, moves focus to the first problem, and saves with a toast.
- [Data table page](https://platform.azmara.io/docs/examples/data-table-page.md): Search, sortable columns, row actions, paging and an empty state, from the Table, Pagination and menu components.
- [Dashboard shell](https://platform.azmara.io/docs/examples/dashboard-shell.md): A navigation list, a top bar with a user menu, stat cards with a loading state, and tabs, laid out with the grid.
- [Confirm-delete flow](https://platform.azmara.io/docs/examples/confirm-delete-flow.md): A menu that opens a confirmation, then a toast with Undo, with the dialog kept next to the menu so it survives it closing.
- [Onboarding wizard](https://platform.azmara.io/docs/examples/onboarding-wizard.md): A step-by-step form with a progress indicator, per-step validation and focus that follows the step.

## Recipes

- [Recipes](https://platform.azmara.io/docs/recipes.md): Short answers to common tasks with @azmr/ui, each with a live demo and the source to copy.
- [Validate a form](https://platform.azmara.io/docs/recipes/form-validation.md): Show an error next to a field in a way a screen reader hears, and put focus on the field that needs fixing.
- [Show a toast while a promise runs](https://platform.azmara.io/docs/recipes/toast-on-promise.md): Report the loading, success and failure of one async call with toast.promise.
- [Open a dialog from a menu item](https://platform.azmara.io/docs/recipes/menu-opens-dialog.md): Confirm something chosen from a menu, without the dialog closing when the menu does.
- [Give each tenant its own theme](https://platform.azmara.io/docs/recipes/theme-per-tenant.md): Apply a brand colour from data to one part of a page, with text colours that stay readable.

## Packages

- [Packages](https://platform.azmara.io/docs/packages.md): Every @azmr package, what it is for, its current version and where to find its docs, changelog and source.
- [@azmr/core](https://platform.azmara.io/docs/packages/core.md): Reactive engine — signals, effects, and computed values.
- [@azmr/query](https://platform.azmara.io/docs/packages/query.md): Chainable, data-first query builder over arrays or reactive Signals.
- [@azmr/db](https://platform.azmara.io/docs/packages/db.md): Secure, async SQLite persistence adapter built on better-sqlite3.
- [@azmr/db-core-interface](https://platform.azmara.io/docs/packages/db-core-interface.md): The DbAdapter contract shared by @azmr/db and @azmr/db-supabase — types and DbAdapterError, with no dependencies.
- [@azmr/db-supabase](https://platform.azmara.io/docs/packages/db-supabase.md): A DbAdapter backed by Supabase's PostgREST query builder, the cloud counterpart to the SQLite adapter in @azmr/db.
- [@azmr/ui](https://platform.azmara.io/docs/packages/ui.md): React components wired to reactive Signals.
- [@azmr/ai](https://platform.azmara.io/docs/packages/ai.md): AI auto-fix system with true V8 isolate sandboxing.
- [@azmr/security](https://platform.azmara.io/docs/packages/security.md): Shared security utilities — validation, RBAC, JWT, audit logging, sanitisation, and env guards.
- [@azmr/policycore](https://platform.azmara.io/docs/packages/policycore.md): Security policy engine — rate limits, auth, CORS, request signing, secrets, API keys, and OWASP Top 10 reporting.
- [@azmr/cli](https://platform.azmara.io/docs/packages/cli.md): Command-line tooling for the Azmara Platform.

## Security

- [Security Overview](https://platform.azmara.io/docs/security/overview.md): Security is not an add-on in Azmara — it is baked into every layer from the ground up.
- [Audit Logging](https://platform.azmara.io/docs/security/audit-logging.md): Every mutation in @azmr/db and every AI fix attempt is written to a tamper-evident audit log.
- [AI Sandbox](https://platform.azmara.io/docs/security/sandbox.md): All AI-generated code runs inside a secure V8 isolate before being applied to any file.
- [Input Validation](https://platform.azmara.io/docs/security/input-validation.md): All data entering the platform from external sources is validated with Zod before being processed.

## Optional

- [@azmr/ai changelog](https://platform.azmara.io/docs/changelog/ai.md): Release history for @azmr/ai.
- [@azmr/cli changelog](https://platform.azmara.io/docs/changelog/cli.md): Release history for @azmr/cli.
- [@azmr/core changelog](https://platform.azmara.io/docs/changelog/core.md): Release history for @azmr/core.
- [@azmr/db changelog](https://platform.azmara.io/docs/changelog/db.md): Release history for @azmr/db.
- [@azmr/db-core-interface changelog](https://platform.azmara.io/docs/changelog/db-core-interface.md): Release history for @azmr/db-core-interface.
- [@azmr/db-supabase changelog](https://platform.azmara.io/docs/changelog/db-supabase.md): Release history for @azmr/db-supabase.
- [@azmr/policycore changelog](https://platform.azmara.io/docs/changelog/policycore.md): Release history for @azmr/policycore.
- [@azmr/query changelog](https://platform.azmara.io/docs/changelog/query.md): Release history for @azmr/query.
- [@azmr/security changelog](https://platform.azmara.io/docs/changelog/security.md): Release history for @azmr/security.
- [@azmr/ui changelog](https://platform.azmara.io/docs/changelog/ui.md): Release history for @azmr/ui.