PluginArea: port old README docs to JSDoc

WordPress · Mar 6, 2019 · 8add505 · 8add505
1 parent 47e366f
commit 8add505
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/packages/plugins/README.md b/packages/plugins/README.md
@@ -46,6 +46,19 @@ Returns all registered plugins.
 
 A component that renders all plugin fills in a hidden div.
 
+**Usage**
+
+```js
+const { PluginArea } = wp.plugins;
+
+const Layout = () => (
+	<div>
+		Content of the page
+		<PluginArea />
+	</div>
+);
+```
+
 **Returns**
 
 `WPElement`: Plugin area.

diff --git a/packages/plugins/src/components/plugin-area/index.js b/packages/plugins/src/components/plugin-area/index.js
@@ -18,6 +18,18 @@ import { getPlugins } from '../../api';
 /**
  * A component that renders all plugin fills in a hidden div.
  *
+ * @example
+ * ```js
+ * const { PluginArea } = wp.plugins;
+ *
+ * const Layout = () => (
+ * 	<div>
+ * 		Content of the page
+ * 		<PluginArea />
+ * 	</div>
+ * );
+ * ```
+ *
  * @return {WPElement} Plugin area.
  */
 class PluginArea extends Component {