# ckeditor5_phoenix v1.25.1 - Table of Contents CKEditor 5 integration for Phoenix Framework ## Pages - [CKEditor 5 Phoenix Integration](readme.md) - [LICENSE](license.md) ## Modules - [CKEditor5](CKEditor5.md): The main module for CKEditor 5 integration in Phoenix Framework. - [CKEditor5.Cloud](CKEditor5.Cloud.md): Represents the Cloud configuration for a CKEditor 5 preset. - [CKEditor5.Cloud.AssetPackage](CKEditor5.Cloud.AssetPackage.md): Represents a single asset package containing JavaScript and CSS assets. This module provides functionality to merge multiple asset packages. - [CKEditor5.Cloud.AssetPackage.CKBox](CKEditor5.Cloud.AssetPackage.CKBox.md): Generates asset package URLs for CKBox. - [CKEditor5.Cloud.AssetPackage.CKEditor5](CKEditor5.Cloud.AssetPackage.CKEditor5.md): Generates asset package URLs for CKEditor5 core files. - [CKEditor5.Cloud.AssetPackage.CKEditor5PremiumFeatures](CKEditor5.Cloud.AssetPackage.CKEditor5PremiumFeatures.md): Generates asset package URLs for CKEditor5 Premium Features. - [CKEditor5.Cloud.AssetPackage.JSAsset](CKEditor5.Cloud.AssetPackage.JSAsset.md): Represents a JavaScript asset in an asset package. - [CKEditor5.Cloud.AssetPackageBuilder](CKEditor5.Cloud.AssetPackageBuilder.md): Module responsible for building asset packages for CKEditor5 cloud resources. - [CKEditor5.Cloud.CKBox](CKEditor5.Cloud.CKBox.md): Represents the CKBox configuration for a CKEditor 5 preset. - [CKEditor5.Cloud.CKEditorCloudUrlBuilder](CKEditor5.Cloud.CKEditorCloudUrlBuilder.md): Builds URLs for CKEditor 5 Cloud resources (CKEditor CDN and CKBox CDN). Implements the CKEditor5.Cloud.UrlBuilder behavior. - [CKEditor5.Cloud.UrlBuilder](CKEditor5.Cloud.UrlBuilder.md): Behavior for building URLs for CKEditor 5 Cloud resources. - [CKEditor5.Components.AssignStyles](CKEditor5.Components.AssignStyles.md): Handles style assignments for the Editor component. - [CKEditor5.Components.Cloud.Assets](CKEditor5.Components.Cloud.Assets.md): A component for rendering all necessary CKEditor 5 assets from the cloud. This includes the import map, stylesheets, and UMD scripts. - [CKEditor5.Components.Cloud.Assigns](CKEditor5.Components.Cloud.Assigns.md): Provides module responsible for creating %Cloud{} structures based on the provided assigns. - [CKEditor5.Components.Cloud.Importmap](CKEditor5.Components.Cloud.Importmap.md): A component for rendering import map script tags of CKEditor 5 in Phoenix. - [CKEditor5.Components.Cloud.ModulePreload](CKEditor5.Components.Cloud.ModulePreload.md): A component for rendering module preload link tags of CKEditor 5 in Phoenix. - [CKEditor5.Components.Cloud.Stylesheets](CKEditor5.Components.Cloud.Stylesheets.md): A component for rendering stylesheet link tags of CKEditor 5 in Phoenix. - [CKEditor5.Components.Cloud.UmdScripts](CKEditor5.Components.Cloud.UmdScripts.md): A component for rendering UMD script tags of CKEditor 5 in Phoenix. - [CKEditor5.Components.Context](CKEditor5.Components.Context.md): A component for rendering a CKEditor5 context. - [CKEditor5.Components.Editable](CKEditor5.Components.Editable.md): Live View component for rendering an editable area in CKEditor 5. It may be used with decoupled editors or multiroot editors. - [CKEditor5.Components.Editor](CKEditor5.Components.Editor.md): LiveView component for CKEditor 5 integration in Phoenix Framework. - [CKEditor5.Components.Editor.Assigns](CKEditor5.Components.Editor.Assigns.md): Handles assigns processing for the Editor component. - [CKEditor5.Components.Editor.AttributeValidator](CKEditor5.Components.Editor.AttributeValidator.md): Validates attributes for different editor types in the Editor component. - [CKEditor5.Components.Editor.EditableHeightNormalizer](CKEditor5.Components.Editor.EditableHeightNormalizer.md): Normalizes and transforms values for the Editor component. - [CKEditor5.Components.Editor.LanguageHandler](CKEditor5.Components.Editor.LanguageHandler.md): Provides a list of supported CKEditor 5 language codes and handles language code normalization for CKEditor integration. - [CKEditor5.Components.Editor.PresetHandler](CKEditor5.Components.Editor.PresetHandler.md): Handles preset loading and type overriding for the Editor component. - [CKEditor5.Components.Editor.PresetUploadHandler](CKEditor5.Components.Editor.PresetUploadHandler.md): Handles upload URL overrides for the Editor preset. - [CKEditor5.Components.FormAttrs](CKEditor5.Components.FormAttrs.md): Common helper functions for CKEditor5 form components. - [CKEditor5.Components.HiddenInput](CKEditor5.Components.HiddenInput.md): LiveView component for rendering a hidden input field. - [CKEditor5.Components.LanguageNormalizer](CKEditor5.Components.LanguageNormalizer.md): Normalizes language codes for CKEditor integration. - [CKEditor5.Components.UIPart](CKEditor5.Components.UIPart.md): Live View component for rendering a UI part of CKEditor 5, like a toolbar or a menubar. It may be used with decoupled editors. - [CKEditor5.Config](CKEditor5.Config.md): 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. - [CKEditor5.Context](CKEditor5.Context.md): Represents the CKEditor 5 context configuration. - [CKEditor5.Contexts](CKEditor5.Contexts.md): Provides predefined configurations (contexts) for CKEditor 5. - [CKEditor5.CustomTranslations](CKEditor5.CustomTranslations.md): Represents custom translations configuration for CKEditor5. - [CKEditor5.Helpers](CKEditor5.Helpers.md): Common helper functions for CKEditor5 components. - [CKEditor5.Installer](CKEditor5.Installer.md): Module responsible for downloading CKEditor 5 NPM packages into deps folder. - [CKEditor5.Installer.NPMRegistry](CKEditor5.Installer.NPMRegistry.md): Module responsible for interacting with the NPM registry. It fetches and extracts NPM packages to certain locations. - [CKEditor5.License](CKEditor5.License.md): Provides functionality to manage CKEditor 5 license keys. - [CKEditor5.Preset](CKEditor5.Preset.md): Represents a CKEditor 5 preset configuration. - [CKEditor5.Preset.CloudCompatibilityChecker](CKEditor5.Preset.CloudCompatibilityChecker.md): Enforces business rules and compatibility constraints for CKEditor5 presets. Specifically handles Cloud Distribution Channel licensing requirements and configuration validation. - [CKEditor5.Preset.EditorType](CKEditor5.Preset.EditorType.md): Defines the available editor types for CKEditor5 presets. This module provides a schema for the editor types and includes a function to validate them. - [CKEditor5.Preset.Parser](CKEditor5.Preset.Parser.md): Parses CKEditor5 preset configurations. Ensures that the configuration adheres to the expected schema and constraints. - [CKEditor5.Presets](CKEditor5.Presets.md): Provides predefined configurations (presets) for CKEditor 5. - [CKEditor5.Upload.Controller](CKEditor5.Upload.Controller.md): Controller for handling image uploads from CKEditor 5. - Exceptions - [CKEditor5.Errors.CloudCannotBeUsedWithLicenseKey](CKEditor5.Errors.CloudCannotBeUsedWithLicenseKey.md): Exception raised when Cloud cannot be used with the provided license key. - [CKEditor5.Errors.CloudNotConfigured](CKEditor5.Errors.CloudNotConfigured.md): Exception raised when Cloud is not configured in the preset. - [CKEditor5.Errors.ContextNotFound](CKEditor5.Errors.ContextNotFound.md): Exception raised when a CKEditor5 context is not found. - [CKEditor5.Errors.Error](CKEditor5.Errors.Error.md): Represents an error in the CKEditor 5 integration. - [CKEditor5.Errors.InvalidCloudConfiguration](CKEditor5.Errors.InvalidCloudConfiguration.md): Exception raised when a Cloud configuration is invalid. - [CKEditor5.Errors.InvalidContext](CKEditor5.Errors.InvalidContext.md): Exception raised when a CKEditor5 context configuration is invalid. - [CKEditor5.Errors.InvalidCustomTranslations](CKEditor5.Errors.InvalidCustomTranslations.md): Exception raised when custom translations are invalid. - [CKEditor5.Errors.InvalidLicenseKey](CKEditor5.Errors.InvalidLicenseKey.md): Exception raised when an invalid license key is provided. - [CKEditor5.Errors.InvalidPreset](CKEditor5.Errors.InvalidPreset.md): Exception raised when a CKEditor5 preset configuration is invalid. - [CKEditor5.Errors.PresetNotFound](CKEditor5.Errors.PresetNotFound.md): Exception raised when a CKEditor5 preset is not found. ## Mix Tasks - [mix ckeditor5.install](Mix.Tasks.Ckeditor5.Install.md): Installs CKEditor 5 packages.