Skip to content

block-attributes: Add role attribute explanation #70361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 11, 2025
Merged

block-attributes: Add role attribute explanation #70361

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
aaed95b
doc: Update block-attributes README.md with role attribute
im3dabasia Jun 9, 2025
e0c349e
doc: Add example for role content
im3dabasia Jun 9, 2025
0dafb23
doc: Add example of role local
im3dabasia Jun 9, 2025
e4549d6
revert: Whitespace and new line changes
im3dabasia Jun 9, 2025
a18bbfb
doc: Add role attribute related documentation and examples
im3dabasia Jun 9, 2025
97ea4a0
chore: Edit block-attributes.md content portion
im3dabasia Jun 11, 2025
69bf447
chore: Add ref to dev note
im3dabasia Jun 11, 2025
5a99186
revert: Extra whitespace and formating changes
im3dabasia Jun 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
chore: Edit block-attributes.md content portion
  • Loading branch information
@im3dabasia
im3dabasia committed Jun 11, 2025
commit 97ea4a0a774c265e5a63b807a30748adb07ca323
2 changes: 1 addition & 1 deletion docs/reference-guides/block-api/block-attributes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ _Example_: Example `default` values.

The `role` property designates an attribute as being of a particular conceptual type. This property can be applied to any attribute to provide semantic meaning about how the attribute should be handled.

Use `content` to designate the attribute as user-editable content. Blocks with attributes marked as `content` may be enabled for privileged editing in special circumstances such as partially synced Patterns.
Use `content` to designate the attribute as user-editable content. Blocks with attributes marked as `content` may be enabled for privileged editing in special circumstances such as content only locking.
Use `local` to mark the attribute as temporary and non-persistable. Attributes marked as `local` are ignored by the Block Serializer and never saved to post content.

_Example_: `content` role used by the paragraph block
Expand Down