Skip to content
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

Jump to bottom

Docs: add more details about block attributes #33880

Merged
merged 1 commit into from
Aug 9, 2021
Merged

Docs: add more details about block attributes #33880

merged 1 commit into from
Aug 9, 2021

Conversation

johngodley
Copy link
Contributor

@johngodley johngodley commented Aug 4, 2021 •
edited
Loading

Description

The block attributes documentation is a bit sparse on details, and I usually end up looking at core blocks for help.

This adds a lot more detail, with examples that show the block attributes, the HTML, and the attributes parsed from it.

It also includes the enum attribute type.

I've removed the link to the WP REST API documentation as it contains PHP details, and just seems a confusing link.

Types of changes

Documentation update only.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

@johngodley
Docs: add more details about block attributes
7c64f8a 
The block attributes documentation is a bit sparse on details, and I usually end up looking at core blocks for help.

This adds a lot more detail, with examples that show the block attributes, the HTML, and the attributes parsed from it.

It also includes the `enum` attribute type.
@johngodley johngodley added [Type] Developer Documentation Documentation for developers [Status] In Progress Tracking issues with work in progress labels Aug 4, 2021
@johngodley johngodley mentioned this pull request Aug 4, 2021
Closed
@gziolo gziolo added the [Feature] Block API API that allows to express the block paradigm. label Aug 9, 2021
@gziolo gziolo requested a review from a team August 9, 2021 08:27
oandregal
oandregal approved these changes Aug 9, 2021
View reviewed changes
Copy link
Member

@oandregal oandregal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this suggestion, John!

@oandregal oandregal merged commit a631bf1 into trunk Aug 9, 2021
@oandregal oandregal deleted the update/block-attributes-doc branch August 9, 2021 09:41
@github-actions github-actions bot added this to the Gutenberg 11.3 milestone Aug 9, 2021
@youknowriad youknowriad mentioned this pull request Aug 9, 2021
Merged
@skorasaurus
Copy link
Member

Thanks so much for writing this out!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oandregal oandregal oandregal approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@chrisvanpatten chrisvanpatten Awaiting requested review from chrisvanpatten

Assignees
No one assigned
Labels
[Feature] Block API API that allows to express the block paradigm. [Status] In Progress Tracking issues with work in progress [Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Gutenberg 11.3
Development

Successfully merging this pull request may close these issues.
4 participants
@johngodley @skorasaurus @oandregal @gziolo