CKEditor5.Cloud.CKBox (ckeditor5_phoenix v1.21.0)

View Source

Represents the CKBox configuration for a CKEditor 5 preset.

Summary

Functions

Merges the current CKBox configuration with the provided overrides.

Parses a map into a CKBox struct. Returns {:ok, %CKBox{}} if valid, {:error, reason} if invalid.

Parses a map into a CKBox struct. Returns %CKBox{} if valid, raises an error if invalid.

s()

Defines the schema for a raw CKBox configuration map.

Types

t()

@type t() :: %CKEditor5.Cloud.CKBox{theme: String.t() | nil, version: String.t()}

Functions

merge(ckbox, overrides)

Merges the current CKBox configuration with the provided overrides.

parse(map)

Parses a map into a CKBox struct. Returns {:ok, %CKBox{}} if valid, {:error, reason} if invalid.

parse!(ckbox_data)

Parses a map into a CKBox struct. Returns %CKBox{} if valid, raises an error if invalid.

s()

Defines the schema for a raw CKBox configuration map.