API Reference ckeditor5_phoenix v#1.17.0

The main module for CKEditor 5 integration in Phoenix Framework.

Represents the Cloud configuration for a CKEditor 5 preset.

Represents a single asset package containing JavaScript and CSS assets. This module provides functionality to merge multiple asset packages.

Generates asset package URLs for CKBox.

Generates asset package URLs for CKEditor5 core files.

Generates asset package URLs for CKEditor5 Premium Features.

Represents a JavaScript asset in an asset package.

Module responsible for building asset packages for CKEditor5 cloud resources.

Represents the CKBox configuration for a CKEditor 5 preset.

Builds URLs for CKEditor 5 Cloud resources (CKEditor CDN and CKBox CDN). Implements the CKEditor5.Cloud.UrlBuilder behavior.

Behavior for building URLs for CKEditor 5 Cloud resources.

Handles style assignments for the Editor component.

A component for rendering all necessary CKEditor 5 assets from the cloud. This includes the import map, stylesheets, and UMD scripts.

Provides module responsible for creating %Cloud{} structures based on the provided assigns.

A component for rendering import map script tags of CKEditor 5 in Phoenix.

A component for rendering module preload link tags of CKEditor 5 in Phoenix.

A component for rendering stylesheet link tags of CKEditor 5 in Phoenix.

A component for rendering UMD script tags of CKEditor 5 in Phoenix.

A component for rendering a CKEditor5 context.

Live View component for rendering an editable area in CKEditor 5. It may be used with decoupled editors or multiroot editors.

LiveView component for CKEditor 5 integration in Phoenix Framework.

Handles assigns processing for the Editor component.

Validates attributes for different editor types in the Editor component.

Provides a list of supported CKEditor 5 language codes and handles language code normalization for CKEditor integration.

Handles preset loading and type overriding for the Editor component.

Handles upload URL overrides for the Editor preset.

Normalizes and transforms values for the Editor component.

Common helper functions for CKEditor5 form components.

LiveView component for rendering a hidden input field.

Normalizes language codes for CKEditor integration.

Live View component for rendering a UI part of CKEditor 5, like a toolbar or a menubar. It may be used with decoupled editors.

Provides access to CKEditor 5 configuration, specifically the presets defined in the application environment. Prefer to not modify values too much, do it in other modules.

Represents the CKEditor 5 context configuration.

Provides predefined configurations (contexts) for CKEditor 5.

Represents custom translations configuration for CKEditor5.

Exception raised when Cloud cannot be used with the provided license key.

Exception raised when Cloud is not configured in the preset.

Exception raised when a CKEditor5 context is not found.

Represents an error in the CKEditor 5 integration.

Exception raised when a Cloud configuration is invalid.

Exception raised when a CKEditor5 context configuration is invalid.

Exception raised when custom translations are invalid.

Exception raised when an invalid license key is provided.

Exception raised when a CKEditor5 preset configuration is invalid.

Exception raised when a CKEditor5 preset is not found.

Common helper functions for CKEditor5 components.

Module responsible for downloading CKEditor 5 NPM packages into deps folder.

Module responsible for interacting with the NPM registry. It fetches and extracts NPM packages to certain locations.

Provides functionality to manage CKEditor 5 license keys.

Represents a CKEditor 5 preset configuration.

Enforces business rules and compatibility constraints for CKEditor5 presets. Specifically handles Cloud Distribution Channel licensing requirements and configuration validation.

Defines the available editor types for CKEditor5 presets. This module provides a schema for the editor types and includes a function to validate them.

Parses CKEditor5 preset configurations. Ensures that the configuration adheres to the expected schema and constraints.

Provides predefined configurations (presets) for CKEditor 5.

Controller for handling image uploads from CKEditor 5.

Installs CKEditor 5 packages.