@wixc3/simulation-plugins
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

@wixc3/simulation-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 { createSimulation } from '@wixc3/react-simulation';
import { tagsPlugin, cssVarsPlugin } from '@wixc3/simulation-plugins';
import { AutoComplete } from './auto-complete';

createSimulation({
  name: 'some simulation',
  props: { name: 'Joe' },
  componentType: AutoComplete,
  plugins: [
    tagsPlugin.use({
      tags: ['react', 'forms', 'completions'],
    }),
    cssVarsPlugin.use({
      '--label-color': 'red',
    }),
  ],
});

tagsPlugin

Adds relevant tags to the simulation. Useful for indexing the simulations.

cssVarsPlugin

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

License

MIT

Readme

Keywords

none

Package Sidebar

Install

npm i @wixc3/simulation-plugins

Weekly Downloads

1

Version

3.0.0

License

MIT

Unpacked Size

9.15 kB

Total Files

18

Last publish

Collaborators

  • dorza
  • vladba-wix
  • danielgovrin
  • yurimorkovnik
  • ranberko91
  • 0xrezaa
  • gregdamsky
  • alissawix
  • ekaterinaza
  • noammu
  • buchenpilar
  • oleksiiletushev
  • alisalachman
  • vladyslav-baliuk
  • yuriin
  • ilyakwix
  • matang
  • daomry
  • noama
  • shakederin
  • dlvhdr
  • plisovyi
  • pijusn
  • shireewill
  • haryelp
  • iuriikowix
  • itaywix
  • thealmightycrumb
  • devex-infra
  • olehr
  • tomrav
  • avi.vahl
  • alexswix
  • omerk
  • talga
  • cijoe
  • wix-ci
  • wixnpm
  • baraki
  • interal
  • alisey
  • danieleww
  • idoros
  • nadavwix
  • rashellek
  • wtfil
  • denysdovhan
  • vkobeliatskyi
  • pistolpete_
  • nettaru
  • igalh
  • netanelgilad
  • anatfenn
  • erezshasha
  • zemlanin
  • arnonkehat
  • ariki
  • itpurchases
  • danalevy
  • serhiiz
  • oleksandraab
  • idango10
  • mikanadel
  • tetiana0611
  • vladkar
  • yurii-v
  • elig-wix
  • nadav.a
  • vladyslavgoloshchapov