Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More

@wixc3/board-plugins

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@wixc3/board-plugins

Plugins for boards


Version published
Weekly downloads
5
Maintainers
0
Weekly downloads
 
Created

@wixc3/board-plugins

npm version

Plugins can add more meta data, modify the rendering environment, wrap the render result and much more. Plugins are specific to a sub-type of IGeneralMetadata and can use the hooks supplied by the meta data type.

For instance, cssVarsPlugin is only applicable to IRenderable and uses the beforeRender hook.

Usage

import { createBoard } from '@wixc3/react-board';
import { tagsPlugin, cssVarsPlugin } from '@wixc3/board-plugins';
import { AutoComplete } from './auto-complete';

createBoard({
  name: 'some board',
  Board: () => <AutoComplete />,
  plugins: [
    tagsPlugin.use({
      tags: ['react', 'forms', 'completions'],
    }),
    cssVarsPlugin.use({
      '--label-color': 'red',
    }),
  ],
});

tagsPlugin

Adds relevant tags to the board. Useful for indexing the boards.

cssVarsPlugin

Accepts a record containing css var names and values to give them during rendering. Adds those css variables to the canvas style.

License

MIT

FAQs

Package last updated on 22 Sep 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts