Align tutorial with example plugin repo code #12740
Conversation
…rdPress/gutenberg-examples
…rdPress/gutenberg-examples
…rdPress/gutenberg-examples
…aining internationalization and it not being present in the documentation.
There was a problem hiding this comment.
One small tweak. I'd love someone to review the ES5 syntax but the ES6 looks good to me.
Admittedly I'm slightly uncomfortable omitting i18n. I get why (it adds a lot of extra levels to what should be a simple tutorial), but we have to assume people are likely to copy and paste this code and it should, where possible, be an example of the right way, tip-to-toe.
That said the tutorial didn't previously have i18n, so the addition of the note is a welcome improvement from master. I'd be happy to land as-is, then have a separate discussion on i18n in tutorials at a later point.
|
|
||
| function onChangeContent( newContent ) { | ||
| edit: ( props ) => { | ||
| const { attributes: { content }, setAttributes, className } = props; |
There was a problem hiding this comment.
I'd like to see this split across newlines for clarity, e.g.
const {
attributes: {
content,
},
setAttributes,
className,
} = props;(with tabs instead of spaces)
|
It would be good to have i18n in examples, we can links users to full working examples and i18n docs for further reference. Also, https://github.com/WordPress/gutenberg-examples need an update for i18n implementation. |
|
@terriann I see that there are conflicting changes in some files. Would you mind integrating those changes and then ping us for review again? |
| var RichText = editor.RichText; | ||
| var AlignmentToolbar = editor.AlignmentToolbar; | ||
| var BlockControls = editor.BlockControls; | ||
|
|
There was a problem hiding this comment.
I prefer passing in wp as the global, because than you can use additional parts without having to change what is being passed in, or a mistake in the order of items passed in.
( function( wp ) {
var el = wp.element.createElement;
var RichText = wp.editor.RichText;
var AlignmentToolbar = wp.editor.AlignmentToolbar;
var BlockControls = wp.editor.BlockControls;
| window.wp.blocks, | ||
| window.wp.editor, | ||
| window.wp.element | ||
| ) ); |
There was a problem hiding this comment.
See comment above to switch this to just ( window.wp )
| ( function( blocks, editor, element ) { | ||
| var el = element.createElement; | ||
| var RichText = editor.RichText; | ||
|
|
There was a problem hiding this comment.
Same as previous file, using ( function( wp ) {
|
Closing this in favor of #14584 |
Description
Contributing to #11251 from contributor day at WCUS18
I've updated the code references to more closely match the referenced example plugin repo https://github.com/WordPress/gutenberg-examples
After discussion with @0aveRyan we decided to strip the internationalization from the code when outlining the tutorial. A note was added below the code samples to indicate this, but if there is a better suggestion I'm happy to help make changes.
Any other feedback & change requests please ping me - rookie contributor so I'm sure we will need to iterate :)
How has this been tested?
Documentation changes only - not tested.
Screenshots
n/a
Types of changes
Checklist: