Reference

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

• CLI Reference

  Commands and arguments available in the Coralite Command-Line Interface.

• Configuration (coralite.config.js)

  Options and settings for configuring your Coralite project build.

• 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.

• 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.

• 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.

• Non-Features Reference

  Intentionally omitted features, their web platform alternatives, and design reasoning.

• Hydration Readiness & E2E

  Technical details on Coralite's hydration pipelines and testing hooks.

• Coralite Scripts (Deprecated)

  Migration notes for the deprecated coralite-scripts package, now consolidated into the coralite CLI.

• DOM Utilities

  Helper functions provided by the framework to assist with DOM manipulation.

• Type Definitions

  Strict definitions for types and interfaces used across the Coralite framework.

• Coralite Constructor

  Under-the-hood reference for the core Coralite instance and its methods.