Joost De Cock 1fd46554af 🔧 Switched to centrally managed README files

2019-04-19 20:09:30 +02:00

6.8 KiB

Raw Blame History

Note

: This is part of version 2 of FreeSewing.
It is a work in progress, and not ready for prime-time yet

For all questions, please come say hellp in our chatroom on Gitter.

FreeSewing is a free and open source library for made-to-measure sewing patterns

@freesewing/plugin-scalebox

A FreeSewing plugin to add a scalebox to your pattern

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

About FreeSewing

Where the world of makers and developers collide, that's where you'll find FreeSewing.

Our core library is a batteries-included toolbox for parametric design of sewing patterns. It's a modular system (check our list of plugins and getting started is as simple as:

npm init freesewing-pattern

The [getting started] section on freesewing.dev is a good entrypoint to our documentation, but you'll find a lot more there, including our API documentation, as well as examples, and best practices.

If you're a maker, checkout freesewing.org where you can generate our sewing patterns adapted to your measurements.

♥️ Support FreeSewing: Become a patron ♥️

FreeSewing is an open source project run by a community, and financially supported by our patrons.

If you feel what we do is worthwhile, you too should become a patron.

6.8 KiB Raw Blame History