CKEditor5.Cloud (ckeditor5 v0.1.0)

Represents the Cloud configuration for a CKEditor 5 preset.

Summary

Functions

Builds a Cloud struct with default values, allowing for overrides.

Returns default values for Cloud configuration.

Merges the current Cloud configuration with the provided overrides.

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

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

s()

Defines the schema for a raw Cloud configuration map.

Types

t()

@type t() :: %CKEditor5.Cloud{
  ckbox: String.t() | nil,
  premium: boolean(),
  translations: [String.t()],
  version: String.t()
}

Functions

build_struct(overrides \\ %{})

Builds a Cloud struct with default values, allowing for overrides.

defaults()

Returns default values for Cloud configuration.

merge(cloud, overrides)

Merges the current Cloud configuration with the provided overrides.

parse(map)

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

parse!(cloud_data)

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

s()

Defines the schema for a raw Cloud configuration map.