GitHub v1.3.1

Reference

Reference

Explore comprehensive Coralite technical documentation, including architecture, API specifications, data structure definitions.

This section contains strictly technical documentation on API signatures, configuration options, and framework types.

CLI & Config

Core API

  • Pages & Routing Reference

    Definitive API reference for page configuration and Coralite's file-based routing system.

  • Components Reference

    Definitive API reference for Coralite Components, covering named exports, component structure, and authoring rules.

  • Component API Reference

    Signatures, options, and contracts for Named Exports and the defineComponent compatibility wrapper.

  • Imperative Components Reference

    Creation paths, scan boundaries, dependency tracking, runtime loaders, upgrades, ownership, styling, and testing.

  • coralite-ignore Reference

    Literal page regions, literal slots, script/style text, component templates, and the single opt-out directive.

  • Lists & Store Reference

    API reference for global state management, fine-grained list rendering, and virtualization.

  • Forms Reference

    Reference for Form-Associated Custom Elements (FACE), ElementInternals, and validation.

  • Plugins Reference

    Complete API reference for extending Coralite with custom plugins via definePlugin.

  • definePlugin API

    Instructions for extending Coralite's behavior and features with custom plugins.

Built-in Plugins

  • Refs Plugin

    Reference on how to manage the DOM with Coralite's built-in references plugin.

  • Metadata Plugin

    Documentation on the metadata plugin for defining page head elements and SEO tags.

  • Static Assets Plugin

    Guide to the plugin that orchestrates copying raw files during the build.

  • Testing Plugin

    Reference for automatic testing selectors and hydration readiness.

  • Router Plugin

    Opt-in SPA router: outlet swap mechanics, the client router API, navigation guards and events, and the fetch behavior contract.

Ecosystem & Utilities