create-block

ここでは２つの方法を書いている。１つは簡単に追加できるがコントロール名がデフォルトの設定のままで変更できない。しかし、これで問題ないと思う。十分使えるから。もう一つはチェット複雑になるが、コントール設定で自由に名前を設定できる方法である。 簡単にサイドバーにカラーコントロールを追加する方法 最初は非常に簡単にサイドバーに色のコントロールを追加表示する方法になる。これはWordPressのデフォルト設定のテキストになるので変更することはできない。もし変更する場合は、この後の記事に記述しているので参考にしてください。 ユーザーがブロックのテキストの色と背景色コントロールを簡単にサイドバーに追加するには、block.json の supports プロパティに以下のように color プロパティを追加します（13行目）。 この例では color プロパティの値に空のオブジェクトを指定していますが、この設定でもデフォルトで text と background が true なのでテキストと背景の色のコントロールが表示されます。 以下のように13行目に「"color": {}」を追加するだけ。 「edit.js」や「save.js」のレイアウトはデフォルトのまま、以下のblock.jsonを変更しただけカラーが追加されるようになるという簡単設定の方法。 { &quot;$schema&quot;: &quot;https://schemas.wp.org/trunk/block.json&quot;, &quot;apiVersion&quot;: 3, &quot;name&quot;: &quot;create-block/multi-columns&quot;, &quot;version&quot;: &quot;0.1.0&quot;, &quot;title&quot;: &quot;Multi Columns&quot;, &quot;category&quot;: &quot;design&quot;, &quot;icon&quot;: &quot;columns&quot;, &quot;description&quot;: &quot;Example block scaffolded with Create Block tool.&quot;, &quot;example&quot;: {}, &quot;supports&quot;: { &quot;html&quot;: true, &quot;color&quot;: {} }, &quot;attributes&quot;: { &quot;content&quot;: { &quot;type&quot;: &quot;string&quot;, &quot;source&quot;: &quot;html&quot;, &quot;selector&quot;: &quot;p&quot; } }, &quot;textdomain&quot;: &quot;multi-columns&quot;, &quot;editorScript&quot;: &quot;file:./index.js&quot;, &quot;editorStyle&quot;: &quot;file:./index.css&quot;, &quot;style&quot;: &quot;file:./style-index.css&quot;, &quot;viewScript&quot;: &quot;file:./view.js&quot; } このように、block.jsonに「"color": {}」を追加するだけで、以下のようにインスペクターパネルに [色]のコントロールが表示され、しかもテキストも背景も実際に設定できるようになる。ただ、右サイドのコントロールで表示されているテキストはデフォルト設定のままで変更できない。 color プロパティでは値に空のオブジェクトを指定することができますが、プロパティにより指定する値の形式は異なります。例えば、spacing プロパティの場合、以下のようにどの間隔（margin や padding）を有効にするかを個別に指定する必要があります。 つまり、この説明はプロパティの種類により空でも良い場合と、空ではダメな場合もあるということ。 グラデーションをカラーピッカーに追加する また、以下では color に "gradients": true （14行目）を追加して色の背景色でグラデーションを有効にしています。 ここでは、ついでに「パディング」「マージン」「blockGap：ブロックの間隔」の設定も追加している。これだけで機能するようになる。 「edit.js」や「save.js」はデフォルトのまま、以下のblock.jsonを変更しただけ。 { &quot;$schema&quot;: &quot;https://schemas.wp.org/trunk/block.json&quot;, &quot;apiVersion&quot;: 3, &quot;name&quot;: &quot;create-block/multi-columns&quot;, &quot;version&quot;: &quot;0.1.0&quot;, &quot;title&quot;: &quot;Multi Columns&quot;, &quot;category&quot;: &quot;design&quot;, &quot;icon&quot;: &quot;columns&quot;, &quot;description&quot;: &quot;Example block scaffolded with Create Block tool.&quot;, &quot;example&quot;: {}, &quot;supports&quot;: { &quot;html&quot;: true, &quot;color&quot;: { &quot;gradients&quot;: true }, &quot;spacing&quot;: { &quot;margin&quot;: true, &quot;padding&quot;: true, &quot;blockGap&quot;: true } }, &quot;attributes&quot;: { &quot;content&quot;: { &quot;type&quot;: &quot;string&quot;, &quot;source&quot;: &quot;html&quot;, &quot;selector&quot;: &quot;p&quot; } }, &quot;textdomain&quot;: &quot;multi-columns&quot;, &quot;editorScript&quot;: &quot;file:./index.js&quot;, &quot;editorStyle&quot;: &quot;file:./index.css&quot;, &quot;style&quot;: &quot;file:./style-index.css&quot;, &quot;viewScript&quot;: &quot;file:./view.js&quot; } 上記を保存すると、サイズ（spacing）のコントロールが追加されます。また、背景色を選択すると color に gradients を追加したので「グラデーション」のタブが追加されます。 チョット面倒になるが、同じくカラーのコントロール追加方法、コントロール設定で希望のテキストを入れることができるようになる方法 サイドバーでテキストと背景のカラーを設定する設定を作成。 コントロールは、ブロック設定サイドバーにも追加できます（アプリケーション用に新規サイドバーを作成することも）。 APIとしては、InspectorControlsコンポーネントがあります。 ブロックエディターハンドブックで、設定サイドバーの使い方を以下のように説明しています。 設定サイドバーは、あまり使わない設定や、大きな画面スペースが必要な設定で使用されます。設定サイドバーはブロックレベル設定でのみ使用してください。 ブロック内の選択したコンテンツでのみ有効な設定は（例：段落内の選択したテキストに対する「太字」設定）、設定サイドバーの中に置かないでください。設定サイドバーはHTMLモードでブロックを編集するときにも表示されるため、ブロックレベルの設定のみを配置する必要があります。 再び、同じ手順で進めます。 「edit.js」で、WordPressパッケージから必要なコンポーネントをインポートする 「edit.js」で、JSXコードに対応する要素を追加する 「block.json」で、必要な属性を定義する 「edit.js」で、イベントハンドラを定義する 「save.js」で、データを保存する ステップ1. @wordpress/block-editorからInspectorControlsとPanelColorSettingsコンポーネントをインポートする ブロックの特定部分をカスタマイズできるようにするには、必要なコントロールを追加します。例えば、カラーコントロールパネルを実装するには、block-editorモジュールからInspectorControlsとPanelColorSettingsコンポーネントをインポートします。 import { useBlockProps, RichText, AlignmentControl, BlockControls, InspectorControls, PanelColorSettings } from '@wordpress/block-editor'; ステップ2. JSXコードに対応する要素を追加する 次に、Edit関数が返すJSXに、対応する要素を追加します。 ※ JSXとは、JavaScriptにHTMLのような構文を拡張したもので、ReactでUIを記述する際に使われ、HTMLのような記述でコンポーネントを定義できる。 export default function Edit( { attributes, setAttributes } ) { const blockProps = useBlockProps(); const { content, align, backgroundColor, textColor } = attributes; const onChangeContent = ( newContent ) =&gt; { setAttributes( { content: newContent } ) } const onChangeAlign = ( newAlign ) =&gt; { setAttributes( { align: newAlign === undefined ? 'none' : newAlign, } ) } return ( &lt;&gt; &lt;InspectorControls&gt; &lt;PanelColorSettings title={ __( 'Color settings', 'ka-example-block' ) } initialOpen={ false } colorSettings={ [ { value: textColor, onChange: onChangeTextColor, label: __( 'Text color', 'ka-example-block' ) }, { value: backgroundColor, onChange: onChangeBackgroundColor, label: __( 'Background color', 'ka-example-block' ) } ] } /&gt; &lt;/InspectorControls&gt; &lt;BlockControls&gt; &lt;AlignmentControl value={ align } onChange={ onChangeAlign } /&gt; &lt;/BlockControls&gt; &lt;RichText { ...blockProps } tagName=&quot;p&quot; onChange={ onChangeContent } allowedFormats={ [ 'core/bold', 'core/italic' ] } value={ content } placeholder={ __( 'テキストを書く...' ) } style={ { textAlign: align, backgroundColor: backgroundColor, color: textColor } } /&gt; &lt;/&gt; ); } ステップ3. block.jsonに必要な属性を定義する ここで、block.jsonファイルにbackgroundColorとtextColor属性を定義します。 &quot;attributes&quot;: { &quot;content&quot;: { &quot;type&quot;: &quot;string&quot;, &quot;source&quot;: &quot;html&quot;, &quot;selector&quot;: &quot;p&quot; }, &quot;align&quot;: { &quot;type&quot;: &quot;string&quot;, &quot;default&quot;: &quot;none&quot; }, &quot;backgroundColor&quot;: { &quot;type&quot;: &quot;string&quot; }, &quot;textColor&quot;: { &quot;type&quot;: &quot;string&quot; } }, ここで表示するとエラーになる。 ステップ4. イベントハンドラを定義する 次に、入力に応じてbackgroundColorとtextColorを更新する2つの関数を定義します。 const onChangeBackgroundColor = ( newBackgroundColor ) =&gt; { setAttributes( { backgroundColor: newBackgroundColor } ) } const onChangeTextColor = ( newTextColor ) =&gt; { setAttributes( { textColor: newTextColor } ) } ステップ5. データを保存する 最後にsave.jsファイルを開き、スクリプトを以下のように変更します。 変更前： export default function save( { attributes } ) { const { content, align } = attributes; const blockProps = useBlockProps.save( { className: `has-text-align-${ align }` } ); return ( &lt;RichText.Content { ...blockProps } tagName=&quot;p&quot; value={ content } style={ { textAlign: align } } /&gt; ); } 変更後： export default function save( { attributes } ) { const blockProps = useBlockProps.save(); const { content, align, backgroundColor, textColor } = attributes; return ( &lt;RichText.Content { ...blockProps } tagName=&quot;p&quot; value={ content } style={ { textAlign: align, backgroundColor: backgroundColor, color: textColor } } /&gt; ); } ファイルを保存して、エディターでブロックを確認します。ブロックに予期せぬ、または無効なコンテンツが含まれていることを知らせるエラーメッセージが表示される場合があります。 ファイルを保存して、エディターでブロックを確認します。ブロックに予期せぬ、または無効なコンテンツが含まれていることを知らせるエラーメッセージが表示される場合があります。 予期せぬ、または無効なコンテンツのエラーメッセージ このエラーは、save.jsファイルが変更され、データベースに保存されたコードがエディターで使用されているコードと一致しない時に発生します。 これを修正するには、ページを更新し、ブロックのインスタンスを一度削除して、再度投稿に追加してください。 変更を加え、投稿を保存して、フロントエンドで表示します。ブロックエディターで行った変更が、サイトにも反映されているはずです。 このように色を変えることも出来たし、テキストの揃えも機能している。 ここまでの成功したblock.jsonファイル これをコピーして使う場合は4行目と14行目にある「"name": "ka-example-block/ka-example-block"」「"textdomain": "ka-example-block"」を使用しているブロック名に変える必要があることに注意！ { &quot;$schema&quot;: &quot;https://schemas.wp.org/trunk/block.json&quot;, &quot;apiVersion&quot;: 3, &quot;name&quot;: &quot;ka-example-block/ka-example-block&quot;, &quot;version&quot;: &quot;0.1.0&quot;, &quot;title&quot;: &quot;Kinsta Academy Block&quot;, &quot;category&quot;: &quot;widgets&quot;, &quot;icon&quot;: &quot;superhero-alt&quot;, &quot;description&quot;: &quot;An example block for Kinsta &quot;, &quot;example&quot;: {}, &quot;supports&quot;: { &quot;html&quot;: false }, &quot;textdomain&quot;: &quot;ka-example-block&quot;, &quot;editorScript&quot;: &quot;file:./index.js&quot;, &quot;editorStyle&quot;: &quot;file:./index.css&quot;, &quot;style&quot;: &quot;file:./style-index.css&quot;, &quot;viewScript&quot;: &quot;file:./view.js&quot;, &quot;keywords&quot;: [ &quot;kinsta&quot;, &quot;academy&quot;, &quot;superhero&quot; ], &quot;attributes&quot;: { &quot;content&quot;: { &quot;type&quot;: &quot;string&quot;, &quot;source&quot;: &quot;html&quot;, &quot;selector&quot;: &quot;p&quot; }, &quot;align&quot;: { &quot;type&quot;: &quot;string&quot;, &quot;default&quot;: &quot;none&quot; }, &quot;backgroundColor&quot;: { &quot;type&quot;: &quot;string&quot; }, &quot;textColor&quot;: { &quot;type&quot;: &quot;string&quot; } } } ここまでのコピーで、注意することがちゃんとなっていれば正常に表示される。 ここまでの成功したedit.jsファイル コードが薄くなく、全てまともな色で表示されていると正常に表示されるハズである。 以下はそのままコピーして入れても正常に機能するハズである。 import { __ } from '@wordpress/i18n'; // import { useBlockProps } from '@wordpress/block-editor'; //最初の記述 import { useBlockProps, RichText, AlignmentControl, BlockControls, InspectorControls, PanelColorSettings } from '@wordpress/block-editor'; import './editor.scss'; export default function Edit( { attributes, setAttributes } ) { const blockProps = useBlockProps(); const { content, align, backgroundColor, textColor } = attributes; const onChangeContent = ( newContent ) =&gt; { setAttributes( { content: newContent } ) } const onChangeAlign = ( newAlign ) =&gt; { setAttributes( { align: newAlign === undefined ? 'none' : newAlign, } ) } const onChangeBackgroundColor = ( newBackgroundColor ) =&gt; { setAttributes( { backgroundColor: newBackgroundColor } ) } const onChangeTextColor = ( newTextColor ) =&gt; { setAttributes( { textColor: newTextColor } ) } return ( &lt;&gt; &lt;InspectorControls&gt; &lt;PanelColorSettings title={ __( 'Color settings', 'ka-example-block' ) } initialOpen={ false } colorSettings={ [ { value: textColor, onChange: onChangeTextColor, label: __( 'Text color', 'ka-example-block' ) }, { value: backgroundColor, onChange: onChangeBackgroundColor, label: __( 'Background color', 'ka-example-block' ) } ] } /&gt; &lt;/InspectorControls&gt; &lt;BlockControls&gt; &lt;AlignmentControl value={ align } onChange={ onChangeAlign } /&gt; &lt;/BlockControls&gt; &lt;RichText { ...blockProps } tagName=&quot;p&quot; onChange={ onChangeContent } allowedFormats={ [ 'core/bold', 'core/italic' ] } value={ content } placeholder={ __( 'Write your text...' ) } style={ { textAlign: align, backgroundColor: backgroundColor, color: textColor } } /&gt; &lt;/&gt; ); } ここまでの成功したsave.jsファイル import { __ } from '@wordpress/i18n'; import { useBlockProps, RichText } from '@wordpress/block-editor'; import './editor.scss'; export default function save( { attributes } ) { const blockProps = useBlockProps.save(); const { content, align, backgroundColor, textColor } = attributes; return ( &lt;RichText.Content { ...blockProps } tagName=&quot;p&quot; value={ content } style={ { textAlign: align, backgroundColor: backgroundColor, color: textColor } } /&gt; ); }