@icepanel/core

[![npm version](http://img.shields.io/npm/v/@icepanel/core.svg?style=flat)](https://npmjs.org/package/@icepanel/core) [![npm size](https://img.shields.io/bundlephobia/min/@icepanel/core.svg)](https://npmjs.org/package/@icepanel/core) [![npm downloads](htt

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@icepanel/core
Minified + gzip package size for @icepanel/core in KB

Readme

IcePanel Core

npm version npm size npm downloads github issues github prs

This package provides all the core elements and base classes required to create the backend for IcePanel plugins.

Installation

First install the package into your project.

npm install @icepanel/core
yarn add @icepanel/core

Usage

You can then create and export classes for the following plugin types:

  • AppPlugin
  • EnginePlugin
  • NetworkPlugin
  • ToolPlugin
  • VolumePlugin

See the example below of a simple IcePanel app plugin.

import { AppPlugin, IAppPlugin } from '@icepanel/core'

export interface IMyAppStore {}

export default class MyApp extends AppPlugin<IMyAppStore>
  implements IAppPlugin<IMyAppStore> {

  async init() {
    await super.init()
    console.log('My app is starting up')
  }

  async destroy() {
    console.log('My app is being destroyed')
    await super.destroy()
  }
}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.