Skip to content

idyll-lang/idyll-apparatus-component

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

idyll-apparatus-component

Component base class to make it easy to integrate Apparatus into Idyll projects.

See more about this at https://mathisonian.com/writing/apparatus

Installation

First, set up an Idyll project.

Inside your idyll project:

npm install --save idyll-apparatus-component

Usage

[IdyllApparatusComponent
  _url:"path to json spec"
  _regionOfInterest:`{ x: [-1, 1], y: [-1, 1] }`
  _width: 300
  _height: 300  /]

Binding variables

Any property passed to the apparatus component that doesn't start with an underscore will be bound to the apparatus attribute of the same name. For example, to bind an Idyll variable named IdyllN to an Apparatus attribute called N:

[var name:“IdyllN” value:0 /]

[IdyllApparatusComponent
  _url: ...”
  _regionOfInterest: roi
  _width: 300
  _height: 300
  N:IdyllN /]

About

Component base class to make it easy to integrate Apparatus into Idyll projects

Resources

License

Stars

Watchers

Forks

Packages

No packages published