1
0
Fork 0
freesewing/markdown/dev/reference/plugins/scalebox/en.md
2022-02-19 08:04:25 +01:00

1.2 KiB

title
@freesewing/plugin-scalebox

The @freesewing/plugin-scalebox plugin provides the scalebox macro with facilitates adding a scalebox to your design, so users can verify that the pattern is printed at the correct scale.

An example of the scalebox

FreeSewing branding can be overruled at runtime

This plugin by default includes FreeSewing branding, but you can override that when calling the scalebox macro in case you want to generate your own branded designs.

The scalebox plugin is part of our plugin-bundle

Installation

npm install @freesewing/plugin-scalebox

Usage

Like all build-time plugins, you load them by passing them to the freesewing.Design super-constructor:

import freesewing from "@freesewing/core";
import scalebox from "@freesewing/plugin-scalebox";
import config from "../config";

const Pattern = new freesewing.Design(config, scalebox);

Now you can use the scalebox macro in your parts.