API Reference
Types, methods, and contracts — the dry details.
Core
| Page | What it covers |
|---|---|
| Engine | AlapEngine, ExpressionParser, mergeConfigs, validateConfig, sanitizeUrl, shared utilities |
| Types | AlapConfig, AlapLink, AlapSettings, AlapMacro, AlapSearchPattern, AlapProtocol, constants |
| Config Registry | registerConfig, updateRegisteredConfig, getEngine, getConfig, named configs |
Renderers
| Page | What it covers |
|---|---|
| Lightbox | AlapLightbox, <alap-lightbox>, options, CSS custom properties, ::part() selectors |
| Lens | AlapLens, <alap-lens>, options, transitions, meta fields, CSS custom properties, ::part() selectors |
| Embeds | createEmbed, providers (YouTube, Vimeo, Spotify, CodePen, CodeSandbox), consent management |
| Placement | computePlacement, parsePlacement, strategies (place/flip/clamp), fallback order, DOM helpers |
| Coordinators | RendererCoordinator (transitions, View Transitions API), InstanceCoordinator (cross-instance dismiss) |
Infrastructure
| Page | What it covers |
|---|---|
| Events | Event types, delivery by adapter, keyboard navigation, hook filtering, dismiss behavior |
| Storage | ConfigStore interface, createIndexedDBStore, createRemoteStore, createHybridStore |
| Security | URL sanitization, ReDoS protection, config validation, parser resource limits |
| Servers | REST API contract (7 endpoints), 11 server examples, OpenAPI spec, quick start |
See also
- Types is the reference companion to Configuration
- Events applies to every Framework Guide
- Security is especially relevant when loading configs from Storage or Servers
- Full documentation index