-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
Try Building a Template Block #1970
Closed
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
5417e6a
Add a sample template block
nb b6d204a
Extract the transformation into its own function
nb 6e30b3d
Extra AttributeInput component
nb 763f741
Switch to `span` from `p` for the main tag
nb dd7af5b
Switch to the extracted functionality
nb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,3 +16,4 @@ import './freeform'; | |
import './latest-posts'; | ||
import './cover-image'; | ||
import './verse'; | ||
import './template'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/** | ||
* WordPress dependencies | ||
*/ | ||
import { __ } from 'i18n'; | ||
|
||
/** | ||
* Internal dependencies | ||
*/ | ||
import { registerBlockType, transformComponentToText } from '../../api'; | ||
import AttributeInput from 'components/attribute-input'; | ||
|
||
function template( mode ) { | ||
return function( { attributes, setAttributes } ) { | ||
return <span> | ||
Hi, my name is { | ||
'edit' === mode ? | ||
<AttributeInput type="text" placeholder="Peter" value={ attributes.name } attribute="name" setAttributes={ setAttributes } /> : | ||
attributes.name | ||
}! <br /> | ||
#intro { tagify( attributes.name ) } | ||
</span>; | ||
}; | ||
} | ||
|
||
function tagify( name ) { | ||
return name ? '#' + name.toLowerCase().replace( /\s+/g, '-' ) : ''; | ||
} | ||
|
||
registerBlockType( 'core/template', { | ||
title: __( 'Template for Templates' ), | ||
defaultAttributes: { | ||
name: '', | ||
}, | ||
transforms: { | ||
to: [ transformComponentToText( template( 'save' ) ) ], | ||
}, | ||
|
||
icon: 'list-view', | ||
category: 'widgets', | ||
|
||
edit: template( 'edit' ), | ||
save: template( 'save' ), | ||
} ); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
The `AttributeInput` component can be used to add an `input` to a block, whose value is always synchronized with a certain attribute. | ||
|
||
#### Props | ||
|
||
The following props are used to tell us which attrbute to connect the `input` to and how to update the attribute value. Any additional props will be passed to the rendered `<input />`. | ||
|
||
* `attribute`: (string) the name of the block attribute to connect the `input` to. | ||
* `setAttribute`: (function) the block's `setAttribute` function, we need it to be able to set the attribute value when the input changes. | ||
|
||
#### Example: | ||
|
||
```javascript | ||
registerBlockType( 'example/hello', { | ||
title: __( 'Hello' ), | ||
icon: 'list-view', | ||
category: 'widgets', | ||
edit: ( { attributes, setAttributes } ) => ( | ||
<span>Enter your name: <AttributeInput type="text" value={ attributes.name } placeholder="Baba" attribute="name" setAttributes={ setAttributes } /></span> | ||
), | ||
save: ( { attributes } ) => ( | ||
<span>Hello, { attributes.name }!</span> | ||
), | ||
} ); | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
export default function AttributeInput( { attribute, setAttributes, value = '', ...inputProps } ) { | ||
return <input value={ value } onChange={ ( e ) => setAttributes( { [ attribute ]: e.target.value } ) } { ...inputProps } />; | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be in a separate "WordPress dependencies block":
https://github.com/WordPress/gutenberg/blob/master/docs/coding-guidelines.md#imports
Note with #2172, these need to be updated to prefix the dependencies with
@wordpress/
. You will need to perform a rebase against the latest version of master and apply your changes: