Skip to content

edit-post: set up autogenerated API docs #14271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oandregal merged 6 commits into from
Mar 11, 2019
Merged

edit-post: set up autogenerated API docs #14271

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b1b62bd
Autogenerated docs and setup for edit-post
oandregal Mar 1, 2019
53a0318
Use new script
oandregal Mar 6, 2019
9230702
Update docs
oandregal Mar 6, 2019
93a2a03
Fix props params
oandregal Mar 6, 2019
f06dced
Delete file added by accident
oandregal Mar 8, 2019
d46a05d
Add ES5 examples back
oandregal Mar 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix props params
  • Loading branch information
@oandregal
oandregal committed Mar 6, 2019
commit 93a2a03b45ba8c9ba4d81290b7fc4719e17d157c
12 changes: 6 additions & 6 deletions packages/edit-post/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,9 +112,9 @@ const MyButtonMoreMenuItem = () => (

- **props** `Object`: Component properties.
- **props.href** `[string]`: When `href` is provided then the menu item is represented as an anchor rather than button. It corresponds to the `href` attribute of the anchor.
- **icon** `[(string|Element)]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.
- **onClick** `[Function]`: The callback function to be executed when the user clicks the menu item.
- **other** `[...*]`: Any additional props are passed through to the underlying [MenuItem](/packages/components/src/menu-item/README.md) component.
- **props.icon** `[(string|Element)]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.
- **props.onClick** `[Function]`: The callback function to be executed when the user clicks the menu item.
- **props.other** `[...*]`: Any additional props are passed through to the underlying [MenuItem](/packages/components/src/menu-item/README.md) component.

**Returns**

Expand Down Expand Up @@ -264,7 +264,7 @@ const MyPluginSidebar = () => (
- **props.className** `[string]`: An optional class name added to the sidebar body.
- **props.title** `string`: Title displayed at the top of the sidebar.
- **props.isPinnable** `[boolean]`: Whether to allow to pin sidebar to toolbar.
- **icon** `[(string|Element)]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.
- **props.icon** `[(string|Element)]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.

**Returns**

Expand Down Expand Up @@ -297,8 +297,8 @@ const MySidebarMoreMenuItem = () => (
**Parameters**

- **props** `Object`: Component props.
- **target** `string`: A string identifying the target sidebar you wish to be activated by this menu item. Must be the same as the `name` prop you have given to that sidebar.
- **icon** `[(string|Element)]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.
- **props.target** `string`: A string identifying the target sidebar you wish to be activated by this menu item. Must be the same as the `name` prop you have given to that sidebar.
- **props.icon** `[(string|Element)]`: The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.

**Returns**

Expand Down
6 changes: 3 additions & 3 deletions packages/edit-post/src/components/header/plugin-more-menu-item/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ const PluginMoreMenuItem = ( { onClick = noop, ...props } ) => (
*
* @param {Object} props Component properties.
* @param {string} [props.href] When `href` is provided then the menu item is represented as an anchor rather than button. It corresponds to the `href` attribute of the anchor.
* @param {string|Element} [icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.
* @param {Function} [onClick=noop] The callback function to be executed when the user clicks the menu item.
* @param {...*} [other] Any additional props are passed through to the underlying [MenuItem](/packages/components/src/menu-item/README.md) component.
* @param {string|Element} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.
* @param {Function} [props.onClick=noop] The callback function to be executed when the user clicks the menu item.
* @param {...*} [props.other] Any additional props are passed through to the underlying [MenuItem](/packages/components/src/menu-item/README.md) component.
Copy link
Member Author

@oandregal oandregal Mar 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wasn't sure how to document passed-through props. An alternative to this will be to mention it in the description. If folks understand this, I'm happy to go with this approach.

*
* @example
* ```jsx
Expand Down
4 changes: 2 additions & 2 deletions packages/edit-post/src/components/header/plugin-sidebar-more-menu-item/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ const PluginSidebarMoreMenuItem = ( { children, icon, isSelected, onClick } ) =>
* The text within the component appears as the menu item label.
*
* @param {Object} props Component props.
* @param {string} target A string identifying the target sidebar you wish to be activated by this menu item. Must be the same as the `name` prop you have given to that sidebar.
* @param {string|Element} [icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.
* @param {string} props.target A string identifying the target sidebar you wish to be activated by this menu item. Must be the same as the `name` prop you have given to that sidebar.
* @param {string|Element} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.
*
* @example
* ```jsx
Expand Down
2 changes: 1 addition & 1 deletion packages/edit-post/src/components/sidebar/plugin-sidebar/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ function PluginSidebar( props ) {
* @param {string} [props.className] An optional class name added to the sidebar body.
* @param {string} props.title Title displayed at the top of the sidebar.
* @param {boolean} [props.isPinnable=true] Whether to allow to pin sidebar to toolbar.
* @param {string|Element} [icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.
* @param {string|Element} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.
*
* @example
* ```jsx
Expand Down