itmar-block-packages 1.3.7 → 1.3.9

package/README.md

@@ -14,6 +14,13 @@ import {関数名又はコンポーネント名} from "itmar-block-packages"
 npm i @wordpress/scripts@^27.6.0 --save-dev
 
 ## 更新履歴
+= 1.3.9 =  
+- カスタムフックとしてuseDuplicateBlockRemoveを追加。このフックはインナーブロックが挿入されたとき、指定されたブロック名が存在れば、挿入されたブロックを削除する。
+
+= 1.3.8 =  
+- WordPressのデータをRest APIを通して取得する関数等のFieldChoiceControlの機能として、choiceFieldsに登録されるフィールド名がmetaによるカスタムフィールドかacfによるカスタムフィールドかを峻別できるようにフィールド名にmeta_又はacf_という接頭辞を付加するようにした。
+- カスタムフックとしてuseBlockAttributeChangesを追加。このフックはitmar/design-group内のブロックで、指定のブロック名とクラス名のブロックの属性に変化があったとき、その変化の内容を通知する機能をもつ。同一のブロック名とクラス名をもつブロックに対して、変化した属性を自動的に設定する機能もある。
+
 = 1.3.4 =  
 - BlockPlaceコンポーネントの高さにフリーサイズを追加し、デスクトップとモバイルでそれぞれ設定を可能うにした。それに伴ってcssPropertesのheight_prmのシグニチャーを変更。
 
@@ -75,12 +82,61 @@ const is_mobile=useIsMobile();
 useDeepCompareEffect(() => {
 ・・・
 },
-[attributes]
+[attributes])
 
 ```
 ### useFontawesomeIframe
 iframeにfontawesomeを読み込むカスタムフック
 
+### useBlockAttributeChanges
+特定のブロックの属性が変更されたとき、その変更内容を返すカスタムフック。引数に指定されたブロック名のブロックで指定されたクラス名をもつブロックの属性の変更内容を返す。第3引数のフラグにtrueを指定すると同じブロック名で同じクラス名をもつブロックの属性を変更されたブロックの属性で自動的に更新する。ただし、変更内容については、指定された属性名の属性を変更及び比較の対象からはずすことができる。  
+
+#### 引数
+- `clientId` string  
+変更されたことを監視する範囲となるitmar/design-groupブロックのclientId
+- `blockName` string  
+変更の監視対象となるブロック名
+- `className` string  
+変更の監視対象となるブロックが有するクラス名
+- `modFlg` boolean  
+同種ブロックを更新するかどうかのフラグ。デフォルトはfalse
+- `excludeAttributes` object  
+自動更新の対象から除外する属性をオブジェクトで指定する。オブジェクトは属性名をキーとし、値を適宜のデフォルト値とする。ここで指定された属性は更新チェックの対象からも除外される。使わないときは指定しない。
+```
+//clientIdで指定されたブロックの属性変更の内容を返す
+const changedAttributes = useBlockAttributeChanges(
+	clientId,
+	"itmar/design-checkbox",
+	"itmar_filter_checkbox",	
+);
+
+//clientIdで指定されたブロックの属性変更の内容でitmar/design-checkboxという名前のブロックで
+//itmar_filter_checkboxというクラス名をもつブロックの属性を自動更新する。
+//ただし、labelContentという属性とinputValueという属性については更新対象から除外する
+useBlockAttributeChanges(
+	clientId,
+	"itmar/design-checkbox",
+	"itmar_filter_checkbox",
+	true,
+	{ labelContent: "", inputValue: false },
+);
+
+```
+
+### useDuplicateBlockRemove
+インナーブロックが挿入されたとき、指定されたブロック名が存在れば、挿入したブロックを削除する。ユーザーに重複したブロックを挿入させたくないときや特定のブロックが存在するとき、ブロックを挿入させないようにするときに活用する。  
+
+#### 引数
+- `clientId` string  
+インナーブロックの監視する対象となるブロックのclientId
+- `blockNames` array  
+存在をチェックするブロック名。文字列を配列で指定する。
+
+```
+useDuplicateBlockRemove(clientId, ["itmar/pickup-posts"]);
+
+```
+
 ## styled-componet用のcssプロパティ生成関数
 styled-componetのcssヘルパー関数内で使用するcssのパラメーターやプロパティを返します。
 ### radius_prm
@@ -141,13 +197,20 @@ px値
 
 ### align_prm
 marginによる横方向の配置のためのCSSを返します。
+また、camelFlgを設定することで、インナースタイル用のオブジェクトを返します。
 #### 引数
-- `align` string  
+- `align` string
+- `camelFLg` boolean  
 center,rightの文字列
 #### 戻り値
+camelFLgがfalse又は設定されていないとき
 - centerのとき`margin-left: auto; margin-right: auto;`
 - rightのとき`margin-left: auto; margin-right: 0`
 - その他の文字列`margin-right: auto; margin-left: 0`
+camelFLgがtrueのとき
+- centerのとき` { marginLeft: "auto", marginRight: "auto" }`
+- rightのとき` { marginLeft: "auto" }`
+- その他の文字列`{}`
   
 
 ### convertToScss
@@ -491,13 +554,19 @@ WordPressのブロックエディタのサイドバーにFont awesomのアイコ
 		icon_size: "24px",
 		icon_color: "var(--wp--preset--color--content)",
 		icon_space: "5px",
+    	icon_family: "Font Awesome 6 Free",
+
 	}
+	setPosition={true}
 	onChange={(newValue) => {
 		setAttributes({icon_style: newValue})
 	}}
 />
 ```
 
+iconStyleオブジェクトを再設定します。
+setPositionプロプスをtrueにするとicon_posとicon_spaceの各オブジェクトを設定するコントロールが表示されます。
+
 <img src="./img/iconControl.png" alt="IconSelectControlのスクリーンショット" width="100" height="200">
 
 ## DOM要素をラップしてレンダリングを変化させるReactコンポーネント

package/build/index.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('react', 'react-dom', 'wp-api-fetch', 'wp-block-editor', 'wp-components', 'wp-data', 'wp-element', 'wp-i18n', 'wp-primitives'), 'version' => '48507471d4cc04eabfc2');
+<?php return array('dependencies' => array('react', 'react-dom', 'wp-api-fetch', 'wp-block-editor', 'wp-components', 'wp-data', 'wp-element', 'wp-i18n', 'wp-primitives'), 'version' => '6e3f73ce618d3c7c0f86');