Effect operations

3 operations named effect.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.

Updated10/26/2026

Operation	What it does	Permission	Confirmation
effect.list	List the effect presets the editor offers, the built-in effects first, then the site's own: each a reveal (meta.reveal), transitions (one transition value in scope, base when absent) or both.	site.read	none
effect.save	Save the reveal and the transition declarations of a page node as a site effect preset.	site.edit	none
effect.delete	Delete a site effect preset; nodes it was applied to keep their reveal and transitions.	site.edit	destructive

effect.list

List the effect presets the editor offers, the built-in effects first, then the site's own: each a reveal (meta.reveal), transitions (one transition value in scope, base when absent) or both. Apply one with tree.commit: set_meta with the reveal, set_style with the transitions.

permission: site.readreads onlyclass: read

Example input

{}

Input

The input is a record; see the schema below.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Output

Field	Type	Required	Notes

Try it

yarn splash effect.list '{}' --dry-run

effect.save

Save the reveal and the transition declarations of a page node as a site effect preset. The transitions are read from scope, else from the first scope of the node that declares one; a node with neither is refused.

permission: site.editwrites: presetsclass: transactionundo: yes

Example input

{
  "pageId": "6f1d2c3b-4a59-4e8d-9c7b-1a2b3c4d5e6f",
  "nodeId": "claim001",
  "label": "Soft lift",
  "scope": "s::hover"
}

Input

Field	Type	Required	Notes
pageId	string	yes	At least 1 character.
nodeId	string	yes
label	string	yes	At least 1 character. At most 80 characters.
id	string	no
scope	string	no

Output

Field	Type	Required	Notes
id	string	yes
label	string	yes	At least 1 character. At most 80 characters.
reveal	object \| object	no
transitions	array of object	no	At least 1 item.
transitions[].property	string	yes
transitions[].duration	string	yes	At least 1 character.
transitions[].easing	string	no	At least 1 character.
transitions[].delay	string	no	At least 1 character.
scope	string	no
source	string	yes	One of "builtin", "site".

Try it

yarn splash effect.save '{"pageId":"6f1d2c3b-4a59-4e8d-9c7b-1a2b3c4d5e6f","nodeId":"claim001","label":"Soft lift","scope":"s::hover"}' --dry-run

effect.delete

Delete a site effect preset; nodes it was applied to keep their reveal and transitions.

permission: site.editwrites: presetsclass: transactionconfirm: destructiveundo: yes

Example input

{
  "effectId": "soft-lift"
}

Input

Field	Type	Required	Notes
effectId	string	yes

Output

Field	Type	Required	Notes
success	true	yes

Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.

Generated from the operation registry and the MCP tool catalogue (source 29edf0002cbbde1c).

Something wrong on this page? Write to docs@librettocms.com.