95 lines
3.4 KiB
Markdown
95 lines
3.4 KiB
Markdown
<p align="center">
|
|
<a title="Go to freesewing.org" href="https://freesewing.org/"><img src="https://freesewing.org/img/logo/black.svg" align="center" width="150px" alt="Freesewing logo"/></a>
|
|
</p>
|
|
<h4 align="center"><em> <a title="Go to freesewing.org" href="https://freesewing.org/">freesewing</a></em>
|
|
<br><sup>a library for made-to-measure sewing patterns</sup>
|
|
</h4>
|
|
<p align="center">
|
|
<a href="https://travis-ci.org/freesewing/plugin-scalebox"><img src="https://badgen.net/travis/freesewing/plugin-scalebox/master" alt="Travis build"></a>
|
|
<a href="https://www.npmjs.com/package/@freesewing/plugin-scalebox"><img src="https://badgen.net/npm/v/@freesewing/plugin-scalebox" alt="Version"></a>
|
|
<a href="https://www.npmjs.com/package/@freesewing/plugin-scalebox"><img src="https://badgen.net/npm/license/@freesewing/plugin-scalebox" alt="License"></a>
|
|
<a href="https://codecov.io/gh/freesewing/plugin-scalebox"><img src="https://badgen.net/codecov/c/github/freesewing/plugin-scalebox/master" alt="Code coverage"></a>
|
|
<a href="https://deepscan.io/dashboard#view=project&pid=3268&bid=27575"><img src="https://deepscan.io/api/projects/3268/branches/27575/badge/grade.svg" alt="DeepScan grade"></a>
|
|
<a href="https://gitter.im/freesewing/freesewing"><img src="https://badgen.net/badge/chat/on%20Gitter/cyan" alt="Chat on Gitter"></a>
|
|
<a href="https://freesewing.org/patrons/join"><img src="https://badgen.net/badge/become/a%20Patron/FF5B77" alt="Become a Patron"></a>
|
|
</p>
|
|
|
|
# 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:
|
|
|
|
```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`:
|
|
|
|
```html
|
|
<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:
|
|
|
|
```js
|
|
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:
|
|
|
|
```sh
|
|
npm install @freesewing/plugin-scalebox
|
|
```
|
|
|
|
## Build
|
|
|
|
To build this plugin, run:
|
|
|
|
```sh
|
|
npm run build
|
|
```
|
|
|