itmar-block-packages 1.2.2 → 1.3.0

package/README.md

@@ -7,6 +7,20 @@ import {関数名又はコンポーネント名} from "itmar-block-packages"
 ```
 名前付きインポートでお願いします。
 
+## 必要条件
+
+このパッケージは`@wordpress/scripts`によるWebPackのトランスパイル環境でトランスパイルされています。そして、このパッケージを使用するには、`@wordpress/scripts`のバージョン^27.6.0以上が必要です。以下のコマンドを実行して、`@wordpress/scripts`を更新してください：
+
+npm i @wordpress/scripts@^27.6.0 --save-dev
+
+## 更新履歴
+= 1.3.0 =  
+- WordPressのデータをRest APIを通して取得する関数等に、次の関数とReactコンポーネントを追加した
+ - restTaxonomies
+ - TermChoiceControl
+- edit.scssおよびstyle.scssを配置し、これをトランスパイルして、複数のプラグインから共通のスタイルとして使用できるようにした
+
+
 # 各コンポーネント・関数の機能
 ## カスタムフック
 ### useIsIframeMobile
@@ -343,27 +357,114 @@ WordPressのブロックエディタのサイドバーにTypographyを設定す
 
 ## WordPressのデータをRest APIを通して取得する関数等
 ### fetchPagesOptions
-固定ページのid,title,linkを返します。
+固定ページの情報を取得して配列で返します。
+#### 引数
+- `homeUrl` string  
+サイトのホームURL  
+
+#### 戻り値
+次のようなキーを持つオブジェクトの配列を返します。  
+`value` 固定ページのid。ただし、サイトのホームについては-1をかえす。  
+`slug` 固定ページのスラッグ  
+`link` 固定ページのURL
+`label` 固定ページの名称  
+
 ### fetchArchiveOptions
-投稿タイプのアーカイブのurlを返します。
+カスタム投稿タイプ（ビルトインを含む）の情報を取得して配列で返します。
+#### 引数
+- `homeUrl` string  
+サイトのホームURL  
+
+#### 戻り値
+次のようなキーを持つオブジェクトの配列を返します。  
+`value` 0から始まる通し番号  
+`slug` ポストタイプのスラッグ  
+`link` アーカイブページのURL
+`label` ポストタイプの名称 
+
+### restTaxonomies
+投稿タイプに登録されているタクソノミー（カテゴリ、タグを含む）の情報およびそのタームの情報をを取得して配列で返します。
+#### 引数
+- `post_type` string  
+投稿タイプのスラッグ  
+
+#### 戻り値
+次のようなキーを持つオブジェクトの配列を返します。  
+`slug` タクソノミーのスラッグ 
+`name` タクソノミーの名称  
+`rest_base` タクソノミーのREST_APIの名称
+`terms` ターム情報オブジェクトの配列 
+
 ### PageSelectControl
-固定ページのタイトルを表示し、そのリンクを返すセレクトコントロールを表示させます。
+固定ページを選択できるコンボボックス表示し、固定ページの情報を返します。
+#### プロプス  
+- `selectedSlug` string  
+選択済みの固定ページのスラッグ 
+- `label` string
+コンボボックスのラベル  
+- `homeUrl` string  
+サイトのホームURL
+- `onChange` func
+コンボボックスの内容が変化したとき発生するコールバック関数。引数には`fetchPagesOptions`の戻り値が入る。 
+
 ```
 <PageSelectControl
-	attributes={attributes}
-	setAttributes={setAttributes}
-	label={__("Select a fixed page to link to", "text-domain")}
-	homeUrl={block_collections.home_url}
+	selectedSlug={selectedSlug}
+	label={__("Select Post Type", "post-blocks")}
+	homeUrl={post_blocks.home_url}
+	onChange={(postInfo) => {
+		setAttributes({ selectedSlug: postInfo.slug });
+	}}
 />
 ```
+
 ### ArchiveSelectControl
-投稿タイプ名を表示し、そのアーカイブのURLを返すセレクトコントロールを表示させます。
+投稿タイプ名を選択できるコンボボックス表示し、投稿タイプの情報を返します。
+#### プロプス  
+- `selectedSlug` string  
+選択済みの投稿タイプのスラッグ 
+- `label` string
+コンボボックスのラベル  
+- `homeUrl` string  
+サイトのホームURL
+- `onChange` func
+コンボボックスの内容が変化したとき発生するコールバック関数。引数には`fetchArchiveOptions`の戻り値が入る。 
+
 ```
 <ArchiveSelectControl
-	attributes={attributes}
-	setAttributes={setAttributes}
-	label={__("Select archive page to link to", "text-domain")}
-	homeUrl={block_collections.home_url}
+	selectedSlug={selectedSlug}
+	label={__("Select Post Type", "post-blocks")}
+	homeUrl={post_blocks.home_url}
+	onChange={(postInfo) => {
+		setAttributes({ selectedSlug: postInfo.slug });
+	}}
+/>
+```
+
+### TermChoiceControl
+投稿タイプに紐づけられている全てのタクソノミー（カテゴリ、タグを含む。）に登録されたタームを選択できるチェックボックス表示し、コールバック関数に選択されたタームの情報を返します。
+#### プロプス  
+- `selectedSlug` string  
+選択済みの投稿タイプのスラッグ 
+- `choiceTerms` array  
+選択済みのタームの情報。配列の要素は次の形式のオブジェクトであること。  
+{ taxonomy: タクソノミーのスラッグ, term: タームのスラッグ }    
+- `type` string 
+選択するデータのタイプ。将来の拡張のためにセットしている。現時点では"taxonomy"とセットすること。
+- `label` string  
+
+- `onChange` func
+チェックボックスの内容が変化したとき発生するコールバック関数。引数には{ taxonomy: タクソノミーのスラッグ, term: タームのスラッグ }という形式のオブジェクトを要素とする配列が入る。 
+
+```
+<TermChoiceControl
+	selectedSlug={selectedSlug}
+	choiceTerms={choiceTerms}
+	type="taxonomy"
+	label={__("Choice Taxsonomy", "post-blocks")}
+	onChange={(newChoiceTerms) =>
+		setAttributes({ choiceTerms: newChoiceTerms })
+	}
 />
 ```
 
@@ -486,4 +587,4 @@ Hslオブジェクトのlightnessの値
 16進数のRGB表記を受け取り、それを10進数のRGBオブジェクトに変換するためのユーティリティ関数です。
 #### 引数
 - `strRgb16` string  
-#000000形式の１６進数の文字列又はrgb(0,0,0) 形式の文字列
+#000000形式の１６進数の文字列又はrgb(0,0,0) 形式の文字列

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' => '2d2b7a2ad307b5f2f288');
+<?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' => '8e2fa17e0d428f714701');

package/build/index.css

@@ -0,0 +1 @@
+.block-editor-block-inspector .tax_section{margin:10px 0 20px}.block-editor-block-inspector .term_section{margin-top:20px}.block-editor-block-inspector .term_section:nth-child(2){margin-top:10px}.block-editor-block-inspector .tax_label{border-bottom:1px solid #000;border-top:1px solid #000;padding:2px 0}.block-editor-block-inspector .term_check{margin-bottom:5px}