Skip to content

README.md

Latest commit

 

History

History
56 lines (38 loc) · 1.25 KB

README.md

File metadata and controls

56 lines (38 loc) · 1.25 KB
Raw

npm npm NpmLicense

flex-plugin

Library to help building Twilio Flex Plugins.

Installation

npm install flex-plugin

Usage

import { loadPlugin, FlexPlugin } from 'flex-plugin';

class MyPlugin extends FlexPlugin {
  pluginName = 'MyPlugin';

  init(flex, manager) {
    // setup your flex
    flex.TaskCanvas.Content.add(<p>Hello</p>);
  }
}

loadPlugin(MyPlugin);

Contributing

Make sure to follow the instructions in the main repository to setup the project

# Install dependencies and link local packages with each other
cd packages/flex-plugin
npx lerna bootstrap

# Run tests
npm test

# To use your local package in a different project
npm link
# then in a different project
npm link flex-plugin

Contributors

Thank you to all the lovely contributors to this project. Please check the main repository to see all contributors.

License

MIT