Reference

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

CLI & Config #

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

Core API #

• defineComponent API

  Signatures and options for authoring Coralite Web Components.

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

Ecosystem & Utilities #

• Hydration Readiness & E2E

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

• Coralite Scripts

  Details on the scripts used to build and serve Coralite projects.

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