Skip to content

Commit

Permalink
Rebase and build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
t-hamano committed Dec 28, 2023
1 parent 93f63a2 commit 6945bb9
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions packages/edit-site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,7 @@ _Parameters_

### PluginMoreMenuItem

Renders a menu item in `Plugins` group in `More Menu` drop down, and can be used to as a button or link depending on the props provided.
The text within the component appears as the menu item label.
Renders a menu item in `Plugins` group in `More Menu` drop down, and can be used to as a button or link depending on the props provided. The text within the component appears as the menu item label.

_Usage_

Expand Down Expand Up @@ -110,9 +109,7 @@ _Returns_

### PluginSidebar

Renders a sidebar when activated. The contents within the `PluginSidebar` will appear as content within the sidebar.
It also automatically renders a corresponding `PluginSidebarMenuItem` component when `isPinnable` flag is set to `true`.
If you wish to display the sidebar, you can with use the `PluginSidebarMoreMenuItem` component or the `wp.data.dispatch` API:
Renders a sidebar when activated. The contents within the `PluginSidebar` will appear as content within the sidebar. It also automatically renders a corresponding `PluginSidebarMenuItem` component when `isPinnable` flag is set to `true`. If you wish to display the sidebar, you can with use the `PluginSidebarMoreMenuItem` component or the `wp.data.dispatch` API:

```js
wp.data
Expand Down Expand Up @@ -172,9 +169,7 @@ _Parameters_

### PluginSidebarMoreMenuItem

Renders a menu item in `Plugins` group in `More Menu` drop down,
and can be used to activate the corresponding `PluginSidebar` component.
The text within the component appears as the menu item label.
Renders a menu item in `Plugins` group in `More Menu` drop down, and can be used to activate the corresponding `PluginSidebar` component. The text within the component appears as the menu item label.

_Usage_

Expand Down Expand Up @@ -219,16 +214,30 @@ _Returns_

- `WPComponent`: The component to be rendered.

### reinitializeEditor
### PluginTemplateSettingPanel

Reinitializes the editor after the user chooses to reboot the editor after
an unhandled error occurs, replacing previously mounted editor element using
an initial state from prior to the crash.
Renders items in the Template Sidebar below the main information like the Template Card.

_Parameters_
_Usage_

```jsx
// Using ESNext syntax
import { PluginTemplateSettingPanel } from '@wordpress/edit-site';

const MyTemplateSettingTest = () => (
<PluginTemplateSettingPanel>
<p>Hello, World!</p>
</PluginTemplateSettingPanel>
);
```

_Returns_

- `WPComponent`: The component to be rendered.

### reinitializeEditor

- _target_ `Element`: DOM node in which editor is rendered.
- _settings_ `?Object`: Editor settings object.
Undocumented declaration.

<!-- END TOKEN(Autogenerated API docs) -->

Expand Down

0 comments on commit 6945bb9

Please sign in to comment.