Docs: Add explanations about attributes of each Core Block in the documentation (and in the source code) #64057
Description
The only official documentation available for core blocks is located at Block Editor Handbook > Reference Guides > Core Blocks Reference. This page lacks detailed explanations about each core block’s attributes and points the user to the source code for more information.
Providing extra explanations about the attributes of core blocks is essential for developers to fully understand and utilize these blocks effectively.
I propose including JSDoc comments in the Edit component of each block to explain the props.attributes object received by every core block’s edit component.
Besides providing extra info on these attributes directly in the source code, these descriptions could also be used (with some custom extra code) by gen-block-lib-list.js to generate more extended info for each block at Block Editor Handbook > Reference Guides > Core Blocks Reference
- archives
- audio
- avatar
- block
- block-keyboard-shortcuts
- button
- buttons
- calendar
- categories
- classic.scss
- code
- column
- columns
- comment-author-avatar
- comment-author-name
- comment-content
- comment-date
- comment-edit-link
- comment-reply-link
- comment-template
- comments
- comments-pagination
- comments-pagination-next
- comments-pagination-numbers
- comments-pagination-previous
- comments-title
- common.scss
- cover
- details
- editor-elements.scss
- editor.scss
- elements.scss
- embed
- file
- footnotes
- form
- form-input
- form-submission-notification
- form-submit-button
- freeform
- gallery
- group
- heading
- home-link
- html
- image
- latest-comments
- latest-posts
- list
- list-item
- lock-unlock.js
- loginout
- media-text
- missing
- more
- navigation
- navigation-link
- navigation-submenu
- nextpage
- page-list
- page-list-item
- paragraph
- pattern
- post-author
- post-author-biography
- post-author-name
- post-comment
- post-comments-count
- post-comments-form
- post-comments-link
- post-content
- post-date
- post-excerpt
- post-featured-image
- post-navigation-link
- post-template
- post-terms
- post-time-to-read
- post-title
- preformatted
- pullquote
- query
- query-no-results
- query-pagination
- query-pagination-next
- query-pagination-numbers
- query-pagination-previous
- query-title
- quote
- read-more
- rss
- search
- separator
- shortcode
- site-logo
- site-tagline
- site-title
- social-link
- social-links
- spacer
- table
- table-of-contents
- tag-cloud
- template-part
- term-description
- text-columns
- verse
- video
Activity