bPanel

bPanel

  • Getting Started
  • About
  • Developers
  • Showcase

›API

Plugin Development

  • Intro to Plugin Development
  • Blockchain API

Guides

  • Node Info View

API

  • metadata
  • decorate
  • mapComponentState/Dispatch
  • getProps
  • reducers
  • middleware
  • Constants
  • Sockets
  • Decorate Plugins
  • Bundling Plugins
  • bPanel Utils

bPanel UI

  • Introduction
  • Components
  • Utilities

Theming (Skins)

  • Getting Started
  • Theming Defaults
  • Theming Variables

metadata

Metadata is where you tell the app and other users about your plugin. This includes information like the name of your plugin, a description, author information, also a display name where relevant.

Note that the metadata export is required for all plugins.

If you are using bpanel-cli to create your plugin then this will be taken care of for you. Plugin metadata is also saved in the redux store, so you can use the redux devtools to see more about plugins that are installed. In the future, this will help support plugin management through the UI.

Metadata might be expanded in the future to support more flexible plugin functionality. For now, the following properties can be used:

export const metadata = {
  name: 'dashboard',
  displayName: 'My Dashboard',
  pathName: 'home',
  version: require('../package.json').version,
  author: 'bpanel-org',
  order: 0,
  icon: 'home',
  sidebar: true,
  parent: ''
};

Details

PropertyRequired?TypeDetails
nameyesstringUsed to identify your plugin. Must follow npm naming rules
displayNamenostringWill default to name if none is provided
pathNamenostringIf building a view/panel, will be passed to react-router to use as URL of your view
authornostringWho you are
ordernointIf including in sidebar, useful for ordering nav.
If order conflicts between plugins, will sort alphabetically
iconnostringAlso for sidebar navigation.
The name of the font awesome icon to use for your view nav
sidebar or navnoboolDefault: false
If true, bPanel will automatically add sidebar navigation for your plugin view
parentnostringCurrently no support, but will be used for
adding a plugin as child (both in path and in navigation)
← Node Info Viewdecorate →
bPanel
Docs
Quick StartPlugin OverviewTheming Overview
Community
Stack OverflowProject ChatTwitter
More
BlogGitHubStar
Copyright © 2019 bcoin
Icons made by artists from https://www.flaticon.com/authors and licensed under CC 3.0