freesewing/packages/plugin-scalebox

 freesewing
^{a library for made-to-measure sewing patterns}

plugin-scalebox

A freesewing plugin to add a scalebox to your pattern.

Usage

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

On node.js:

import freesewing from 'freesewing'
import scalebox from '@freesewing/plugin-scalebox'

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

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

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

<script>
var pattern = new freesewing.Patter()
  .with(freesewing.plugins.scalebox);
</script>

You can now use the scalebox macro as such:

macro('scalebox', {
  at: new Point(0,0),
  lead: 'This is the lead',
  title: 'This is the title',
  text: "And this is the text\nwhich has room for a few lines should you\nfeel so inclined"
});

Configuration

The macro configuration object takes the following properties:

Name	Description	Default
at	A Point object to anchor the scalebox on
lead	The lead text	freesewing
title	The lead text	pattern name & version
text	The lead text	See example below

Example

This plugin provides the scalebox macro that inserts a scalebox like this:

These are the default values. The example under Usage above would render like this:

Install

To install, run:

npm install @freesewing/plugin-scalebox

Build

To build this plugin, run:

npm run build