From c6f59c6b123d04c5da8c4e008c3822408c9bbb0f Mon Sep 17 00:00:00 2001 From: Ryan Welcher Date: Tue, 16 Jul 2019 16:19:11 -0400 Subject: [PATCH 1/6] Adds Documentation for the PluginDocumentSettingPanel SlotFill --- .../plugin-document-setting-panel.md | 25 +++++++++++++++++++ docs/manifest-devhub.json | 6 +++++ docs/toc.json | 1 + 3 files changed, 32 insertions(+) create mode 100644 docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md diff --git a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md new file mode 100644 index 0000000000000..18926096223d7 --- /dev/null +++ b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md @@ -0,0 +1,25 @@ +# PluginBlockSettingsMenuItem + +This SlotFill allows adding items below the Status & Availability panel in the Document Sidebar. + +## Available Props +* __name__ `string`: A string identifying the panel. +* __className__ `string`: An optional class name added to the sidebar body. +* __title__ `string`: Title displayed at the top of the sidebar. +* __icon__ `(string|Element)`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element. + +## Example +```js +const { registerPlugin } = wp.plugins; +const { PluginDocumentSettingPanel } = wp.editPost; + +const PluginDocumentSettingPanelDemo = () => ( + + Custom Panel Contents + +); +registerPlugin( 'plugin-document-setting-panel-demo', { render: PluginDocumentSettingPanelDemo, icon: 'palmtree' } ); diff --git a/docs/manifest-devhub.json b/docs/manifest-devhub.json index 1a5dc5fd60f13..84f0bdd474e43 100644 --- a/docs/manifest-devhub.json +++ b/docs/manifest-devhub.json @@ -101,6 +101,12 @@ "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md", "parent": "slotfills" }, + { + "title": "PluginBlockSettingsMenuItem", + "slug": "plugin-document-setting-panel", + "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md", + "parent": "slotfills" + }, { "title": "PluginMoreMenuItem", "slug": "plugin-more-menu-item", diff --git a/docs/toc.json b/docs/toc.json index 8b3f3b4d8a4fe..8f42aa7d2fa71 100644 --- a/docs/toc.json +++ b/docs/toc.json @@ -18,6 +18,7 @@ ] }, {"docs/designers-developers/developers/slotfills/README.md": [ { "docs/designers-developers/developers/slotfills/plugin-block-settings-menu-item.md": [] }, + { "docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-more-menu-item.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-post-publish-panel.md": [] }, { "docs/designers-developers/developers/slotfills/plugin-post-status-info.md": [] }, From c199dfaf16018971e15ad9165db505c4821aed53 Mon Sep 17 00:00:00 2001 From: Ryan Welcher Date: Tue, 16 Jul 2019 16:22:30 -0400 Subject: [PATCH 2/6] Getting the name right on the docs is a good idea --- .../developers/slotfills/plugin-document-setting-panel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md index 18926096223d7..01650b1406391 100644 --- a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md +++ b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md @@ -1,4 +1,4 @@ -# PluginBlockSettingsMenuItem +# PluginDocumentSettingPanel This SlotFill allows adding items below the Status & Availability panel in the Document Sidebar. From 3b1e60c831d46cc54543e8006eb10a8bf9aa949a Mon Sep 17 00:00:00 2001 From: Ryan Welcher Date: Tue, 16 Jul 2019 16:23:57 -0400 Subject: [PATCH 3/6] Regenerate docs --- docs/manifest-devhub.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest-devhub.json b/docs/manifest-devhub.json index 84f0bdd474e43..8c96482e340a3 100644 --- a/docs/manifest-devhub.json +++ b/docs/manifest-devhub.json @@ -102,7 +102,7 @@ "parent": "slotfills" }, { - "title": "PluginBlockSettingsMenuItem", + "title": "PluginDocumentSettingPanel", "slug": "plugin-document-setting-panel", "markdown_source": "../docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md", "parent": "slotfills" From dbe8aa245787e5d912d3a55ddd90c5a3d6134423 Mon Sep 17 00:00:00 2001 From: Ryan Welcher Date: Tue, 16 Jul 2019 16:26:52 -0400 Subject: [PATCH 4/6] Closing example code block and regenerate docs --- .../developers/slotfills/plugin-document-setting-panel.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md index 01650b1406391..f5d98b9f49d78 100644 --- a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md +++ b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md @@ -23,3 +23,4 @@ const PluginDocumentSettingPanelDemo = () => ( ); registerPlugin( 'plugin-document-setting-panel-demo', { render: PluginDocumentSettingPanelDemo, icon: 'palmtree' } ); +``` \ No newline at end of file From 57e442a267eaa535c375908854294d90e309858f Mon Sep 17 00:00:00 2001 From: Ryan Welcher Date: Tue, 16 Jul 2019 16:31:17 -0400 Subject: [PATCH 5/6] Adds new SlotFill to the list --- docs/designers-developers/developers/slotfills/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/designers-developers/developers/slotfills/README.md b/docs/designers-developers/developers/slotfills/README.md index 61e642658a035..991118bdcbff6 100644 --- a/docs/designers-developers/developers/slotfills/README.md +++ b/docs/designers-developers/developers/slotfills/README.md @@ -100,6 +100,7 @@ function PostStatus( { isOpened, onTogglePanel } ) { There are currently seven available SlotFills in the `edit-post` package. Please refer to the individual items below for usage and example details: * [PluginBlockSettingsMenuItem](./plugin-block-settings-menu-item.md) +* [PluginDocumentSettingPanel](./plugin-document-setting-panel.md) * [PluginMoreMenuItem](./plugin-more-menu-item.md) * [PluginPostPublishPanel](./plugin-post-publish-panel.md) * [PluginPostStatusInfo](./plugin-post-status-info.md) From 9a63c5bfde4e60e850a4be6995a84d0951703726 Mon Sep 17 00:00:00 2001 From: Ryan Welcher Date: Fri, 19 Jul 2019 13:44:29 -0400 Subject: [PATCH 6/6] Changes to SlotFill description as per @youknowriad --- .../developers/slotfills/plugin-document-setting-panel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md index f5d98b9f49d78..75f0a3638f1b4 100644 --- a/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md +++ b/docs/designers-developers/developers/slotfills/plugin-document-setting-panel.md @@ -1,6 +1,6 @@ # PluginDocumentSettingPanel -This SlotFill allows adding items below the Status & Availability panel in the Document Sidebar. +This SlotFill allows registering a UI to edit Document settings. ## Available Props * __name__ `string`: A string identifying the panel.