0.1.1 • Published 5 years ago
flypress-metagroups v0.1.1
Flypress Metagroups
A Vue.js plugin for providing admin metagroup and metapanel helper components, designed for use within the Flypress ecosystem.
Installation
The Flypress Metagroups plugin can be installed via npm:
npm install flypress-metagroupsUsage
Include the required resources in your project:
// admin.js
import Vue from 'vue';
import FlypressMetapanels from 'flypress-metapanels';
Vue.use(FlypressMetapanels);
const AdminApp = new Vue({...});Components
metagroup
The metagroup component acts as a wrapper for a collection of metapanels.
Properties
This component has no custom properties.
Example
<metagroup>
<metapanel />
<metapanel />
<metapanel />
</metagroup>metapanel
The metapanel component is used to register and display a single metapanel within a metagroup.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | A unique identifier for the metapanel. |
| label | string | Label to display in the metagroup navigation. Defaults to id. | |
| icon | string | An icon identifier to display in the metagroup navigation. This should be a dashicons id. e.g. admin-media for the dashicons-admin-media icon. |
Example
<metagroup>
<metapanel id="book-author" label="Author" icon="admin-users">
...
</metapanel>
</metagroup>