Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Welcher authored and ryanwelcher committed Aug 27, 2024
1 parent 43f9368 commit e590e69
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions packages/plugins/src/api/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,18 @@ import { isFunction } from 'lodash';
*
* @typedef {Object} WPPlugin
*
* @property {string} name A string identifying the plugin. Must be
* unique across all registered plugins.
* unique across all registered plugins.
* @property {string|WPElement|Function} icon An icon to be shown in the UI. It can
* be a slug of the Dashicon, or an element
* (or function returning an element) if you
* choose to render your own SVG.
* @property {Function} render A component containing the UI elements
* to be rendered.
* @property {number} priority Allows for controlling the display order of this plugin.
* Default is 10.
* @property {string} name A string identifying the plugin. Must be
* unique across all registered plugins.
* @property {string|WPElement|Function} [icon] An icon to be shown in the UI. It can
* be a slug of the Dashicon, or an element
* (or function returning an element) if you
* choose to render your own SVG.
* @property {Function} render A component containing the UI elements
* to be rendered.
* @property {string} [scope] The optional scope to be used when rendering inside
* a plugin area. No scope by default.
* @property {number} [priority] Allows for controlling the display order of this
* plugin. Default is 10.
*/

/**
Expand Down

0 comments on commit e590e69

Please sign in to comment.