1
0
Fork 0
freesewing/packages/plugin-bundle
2019-04-19 17:31:44 +02:00
..
img tada: First commit 2019-04-19 08:17:12 +02:00
src sparkles: Added plugin-sprinkle 2019-04-19 08:17:13 +02:00
tests wrench: Updated rollup config 2019-04-19 08:17:14 +02:00
.editorconfig tada: First commit 2019-04-19 08:17:12 +02:00
.gitignore tada: First commit 2019-04-19 08:17:12 +02:00
.npmignore tada: First commit 2019-04-19 08:17:12 +02:00
.travis.yml Merge branch 'master' of github.com:freesewing/plugin-bundle 2019-04-19 08:17:13 +02:00
LICENSE tada: First commit 2019-04-19 08:17:12 +02:00
package.json 🔧 Centrally confifured package and rollup files 2019-04-19 17:31:44 +02:00
README.md Merge branch 'master' of github.com:freesewing/plugin-bundle 2019-04-19 08:17:14 +02:00
rollup.config.js 🔧 Centrally confifured package and rollup files 2019-04-19 17:31:44 +02:00

Freesewing logo

 freesewing
a library for made-to-measure sewing patterns

Travis build Version License Code coverage DeepScan grade Chat on Gitter Become a Patron

plugin-bundle

A freesewing plugin that provides the following plugins in one bundle:

  1. plugin-cutonfold : Add cut-on-fold indicators to your patterns
  2. plugin-dimension : Add dimensions to your (paperless) patterns
  3. plugin-grainline : Add grainline indicators to your patterns
  4. plugin-logo : Add a scalebox to your patterns
  5. plugin-scalebox : Add pretty titles to your pattern parts
  6. plugin-title : Add pretty titles to your pattern parts
  7. plugin-round : Rounds corners
  8. plugin-sprinkle : Add multiple snippets to your pattern

Note that these are all build-time plugins. In other words, plugins used by developers/pattern designers, rather than run-time plugins that are used when generating patterns.

Without exception, all freesewing patterns use all these plugins, so it made sense to bundle them.

Usage

To load this plugin, add it to your instantiated pattern.

On node.js:

import freesewing from 'freesewing'
import pluginBundle from '@freesewing/plugin-bundle'

let pattern = new freesewing.Pattern()
  .with(pluginBundle);

In the browser, this plugin will register as freesewing.plugins.bundle:

<script type="text/javascript" src="https://unpkg.com/freesewing"></script>
<script type="text/javascript" src="https://unpkg.com/@freesewing/plugin-bundle"></script>

<script>
var pattern = new freesewing.Pattern()
  .with(freesewing.plugins.bundle);
</script>

Install

To install, run:

npm install @freesewing/plugin-bundle

Build

To build this plugin, run:

npm run build