Entrance animations of the Advanced tab.

@spec clear_style(t(), String.t()) :: {:ok, t()} | {:error, :not_found}

Removes every style of a node (all states).

@spec count(t() | tree_node()) :: non_neg_integer()

Number of nodes, the root included.

Devices of the responsive styles.

@spec duplicate(t(), String.t(), ElementorexCms.Registry.t() | nil) ::
  {:ok, t(), String.t()} | {:error, atom()}

Copies the node id (with new ids for it and its children) right after it. Returns the document and the id of the copy.

@spec empty?(t() | nil) :: boolean()

Whether the document has no content.

@spec fetch(t(), String.t() | nil) :: {:ok, tree_node()} | {:error, :not_found}

Like get/2, as {:ok, node} or {:error, :not_found}.

@spec from_json(String.t(), ElementorexCms.Registry.t() | nil) :: t()

Decodes and normalizes a JSON document (an invalid one gives new/0).

@spec get(t(), String.t() | nil) :: tree_node() | nil

The node with id, or nil.

@spec insert(
  t(),
  tree_node(),
  String.t(),
  integer(),
  ElementorexCms.Registry.t() | nil
) ::
  {:ok, t()} | {:error, atom()}

Inserts node in the container parent_id at index (clamped to the children list). Checks that the parent takes that kind of child and the document limits.

Limits applied by normalize/2: %{nodes: 2000, depth: 24}.

@spec move(t(), String.t(), String.t(), integer(), ElementorexCms.Registry.t() | nil) ::
  {:ok, t()} | {:error, atom()}

Moves the node id into parent_id at index. The index is counted in the target's current children (the node itself included when it already is there), which is what the editor's drop indicator shows.

@spec new([tree_node()]) :: t()

An empty document, optionally with root children.

@spec node(String.t(), map(), keyword()) :: tree_node()

A new node of type. props are stored as given (string keys); pass registry: to fill in the defaults of the block and its default children.

Options: :children, :style, :attrs, :id, :registry.

@spec nodes(t() | tree_node()) :: [tree_node()]

Every node, depth first, the root included.

@spec normalize(term(), ElementorexCms.Registry.t() | nil) :: t()

Makes any map a valid document for registry: fills missing keys, casts and sanitizes props with the definitions of each block, keeps only valid styles and Advanced attributes, drops children of non-containers, gives new ids to invalid or repeated ones and enforces the limits (limits/0).

Nodes of unknown types are kept as they are (they render nothing), so a document never loses content because a block was removed from the registry.

Run it on everything that comes from outside: stored JSON, imports, the editor's events.

@spec normalize_attrs(term()) :: map()

Keeps only valid Advanced attributes.

@spec normalize_style(term()) :: map()

Keeps only valid states and declarations of a style map.

@spec parent(t(), String.t()) :: {:ok, tree_node(), non_neg_integer()} | :error

The parent of the node with id and the node's index in it.

@spec path(t(), String.t()) :: [tree_node()]

Nodes from the root down to the node with id (both included), or [] if it does not exist.

@spec put_attr(t(), String.t(), String.t(), term()) ::
  {:ok, t()} | {:error, :not_found}

Sets an Advanced attribute of a node (validated with normalize_attrs/1; an invalid value removes the attribute).

@spec put_prop(t(), String.t(), String.t(), term()) ::
  {:ok, t()} | {:error, :not_found}

Sets a prop of a node (the value is stored as given; cast it first).

@spec put_style(t(), String.t(), String.t(), String.t(), term()) ::
  {:ok, t()} | {:error, :not_found | :invalid}

Sets (or with nil/"" removes) a style declaration of a node for a state ("desktop", "tablet", "mobile" or "hover"). Invalid values are rejected with {:error, :invalid}.

@spec regenerate_ids(t() | tree_node()) :: t() | tree_node()

A copy of a node (or of a whole document) with new ids everywhere.

@spec remove(t(), String.t()) :: {:ok, t()} | {:error, atom()}

Removes the node id and its children. The root cannot be removed.

@spec root(t()) :: tree_node()

The root node.

Style states a node can have (desktop, tablet, mobile, hover).

@spec to_json(t(), keyword()) :: String.t()

Encodes a document as JSON.

@spec update(t(), String.t(), (tree_node() -> tree_node())) ::
  {:ok, t()} | {:error, :not_found}

Applies fun to the node with id. The id and type cannot change.

Current version of the document format.

@spec within?(t(), String.t(), String.t()) :: boolean()

Whether id is ancestor_id or one of its descendants.