BlueRain
Github
  • 💧Introduction
  • Overview
    • 📲Quick Start
    • 🎛️Configuration with bluerain.js
    • 🎡Lifecycle Events
    • 🛣️Roadmap
  • Key Concepts
    • 🔌Plugins
      • Developing an Analytics Plugin
      • Developing a Logger Plugin
      • Developing a Theme Plugin
    • 🎣Hooks
    • 🎁Components
    • 📦BlueRain Modules
    • 🎛️Configs
    • 📈Analytics
    • 📔Logger
    • 🎨Themes
      • Installation
      • Consuming Selected Theme
      • Customise Themes
      • Customise Components
      • Theme Configs
      • Theme Structure
    • Registry
  • Guides
    • 🗿Icons
    • 🛂Migrating from V3
  • Components
    • Typography
    • Icons
      • Icon
      • DynamicIcon 📌
      • PluginIcon 📌
  • CLI
    • Expo
    • Web
    • Storybook (Web)
    • Storybook Native (Expo)
Powered by GitBook
On this page
  • API
  • Plugin Categories
  1. Key Concepts

Plugins

In BlueRain all functionality and features in an app are added as plugins. Each plugin is a separate NPM package.

A plugin can add components, routes and hooks.

API

A plugin object can have the following properties:

Key

Type

Required

Description

name

string

yes

Name of the plugin.

slug

string

no

This property is used as an ID throughout the system. If a slug is not provided, it will be auto-generated by name property.

description

string

no

Plugin description.

version

string

no

Plugin version.

categories

string | string[]

no

icon

enabled

boolean

no

(Default = true) Flag to check if a plugin is enabled.

hooks

components

Plugin Categories

  • app

  • store

  • router

  • logger

  • theme

  • analytics

PreviousRoadmapNextDeveloping an Analytics Plugin

Last updated 6 years ago

.

🔌
Plugin Categories