fix(docs): Update plugins documentation
This commit is contained in:
parent
7063d8ab9f
commit
767d835cc6
23 changed files with 272 additions and 51 deletions
|
@ -18,9 +18,15 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { bannerPlugin } from '@freesewing/plugin-banner'
|
||||||
|
// or
|
||||||
|
import { pluginBanner } from '@freesewing/plugin-banner'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The banner plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The banner plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-banner
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-banner
|
||||||
|
|
||||||
|
|
|
@ -5,7 +5,7 @@ title: plugin-bartack
|
||||||
Published as [@freesewing/plugin-bartack][1], this plugin provides
|
Published as [@freesewing/plugin-bartack][1], this plugin provides
|
||||||
the [bartack](/reference/macros/bartack),
|
the [bartack](/reference/macros/bartack),
|
||||||
[bartackAlong](/reference/macros/bartackalong), and
|
[bartackAlong](/reference/macros/bartackalong), and
|
||||||
the [bartackFractionAlong](/reference/macros/bartack) macros
|
the [bartackFractionAlong](/reference/macros/bartackfractionalong) macros
|
||||||
which allows you to add bartacks — a set
|
which allows you to add bartacks — a set
|
||||||
of tight zig-zag stitches used to enforce a seam — to your design.
|
of tight zig-zag stitches used to enforce a seam — to your design.
|
||||||
|
|
||||||
|
@ -21,9 +21,15 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { bartackPlugin } from '@freesewing/plugin-bartack'
|
||||||
|
// or
|
||||||
|
import { pluginBartack } from '@freesewing/plugin-bartack'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The bartack plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The bartack plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-bartack
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-bartack
|
||||||
|
|
||||||
|
|
|
@ -35,3 +35,11 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { bundlePlugin } from '@freesewing/plugin-bundle'
|
||||||
|
// or
|
||||||
|
import { pluginBundle } from '@freesewing/plugin-bundle'
|
||||||
|
```
|
||||||
|
|
||||||
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-bundle
|
||||||
|
|
|
@ -5,7 +5,7 @@ title: plugin-bust
|
||||||
Published as [@freesewing/plugin-bust][1], this plugin helps you adapt menswear
|
Published as [@freesewing/plugin-bust][1], this plugin helps you adapt menswear
|
||||||
patterns for people with breasts. If you are designing a womenswear pattern,
|
patterns for people with breasts. If you are designing a womenswear pattern,
|
||||||
you won't need this plugin. But if you're adapting a menswear pattern for
|
you won't need this plugin. But if you're adapting a menswear pattern for
|
||||||
breasts, or merely want to accomodate both people with and without breasts,
|
breasts or merely want to accomodate both people with and without breasts,
|
||||||
this plugin can help you accomplish that.
|
this plugin can help you accomplish that.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
@ -20,6 +20,17 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { bustPlugin } from '@freesewing/plugin-bust'
|
||||||
|
// or
|
||||||
|
import { pluginBust } from '@freesewing/plugin-bust'
|
||||||
|
```
|
||||||
|
|
||||||
|
To import the plugin and condition method for conditional loading:
|
||||||
|
```js
|
||||||
|
import { withCondition } from '@freesewing/plugin-bust'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
|
@ -37,7 +48,7 @@ womenswear pattern for a person with above-average sized breasts.
|
||||||
This plugin helps you by:
|
This plugin helps you by:
|
||||||
|
|
||||||
- Storing the chest circumference in `measurements.bust`
|
- Storing the chest circumference in `measurements.bust`
|
||||||
- Changing `measurments.chestCircumference` to the value of
|
- Changing `measurments.chest` to the value of
|
||||||
`measurements.highBust`
|
`measurements.highBust`
|
||||||
|
|
||||||
### Use when extending breastless patterns into a with-breasts version
|
### Use when extending breastless patterns into a with-breasts version
|
||||||
|
@ -50,32 +61,48 @@ This way you can extend a menswear pattern and have it drafted with the high
|
||||||
bust measurement as chest measurment, after which you can create room for the
|
bust measurement as chest measurment, after which you can create room for the
|
||||||
breasts.
|
breasts.
|
||||||
|
|
||||||
You can see this in practice in our [Carlita][2] pattern, which extends the
|
You can see this in practice in our [Carlita][2] design, which extends the
|
||||||
menswear [Carlton][3] pattern.
|
menswear [Carlton][3] design.
|
||||||
|
|
||||||
<Related compact>
|
<Related compact>
|
||||||
To learn more about extending a pattern, see [Part
|
To learn more about extending a design, see [Part
|
||||||
inheritance](/howtos/code/from/)
|
inheritance](/howtos/code/from/)
|
||||||
</Related>
|
</Related>
|
||||||
|
|
||||||
### Use when creating gender-neutral patterns
|
### Use when creating gender-neutral designs
|
||||||
|
|
||||||
To create a truly gender-neutral pattern — one that will adapt to breasts only
|
To create a truly gender-neutral design — one that will adapt to breasts only
|
||||||
if they are present — you can use this plugin, but you'll also need a few other
|
if they are present — you can use this plugin, but you'll also need a few other
|
||||||
things:
|
things:
|
||||||
|
|
||||||
- You'll need to mark the breast measurements as [optional
|
- You'll need to include and mark the bust measurements, including `highBust`,
|
||||||
|
as [optional
|
||||||
measurements](/reference/api/part/config/measurements#optionalmeasurements)
|
measurements](/reference/api/part/config/measurements#optionalmeasurements)
|
||||||
- You'll need to [conditionally load this
|
- You'll need to [conditionally load this
|
||||||
plugin](/reference/api/part/config/plugins#conditional-plugins)
|
plugin](/reference/api/part/config/plugins#conditional-plugins)
|
||||||
|
- You'll need to create your design such that, when appropriate,
|
||||||
|
it is able to produce the condition to cause the plugin to load
|
||||||
|
|
||||||
You can see an example of this in [our Teagan design][4].
|
You can see an example of this in [our Teagan design][4].
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-banner
|
### Condition for loading `withCondition`
|
||||||
|
|
||||||
|
For convenience, `plugin-bust` provides a `withCondition` named export
|
||||||
|
that is a conditional plugin, an `Object` consisting of the plugin
|
||||||
|
along with a condition method.
|
||||||
|
|
||||||
|
The condition is met if both:
|
||||||
|
1. `options.draftForHighBust` is set to `true`
|
||||||
|
2. `measurements.highBust` is set
|
||||||
|
|
||||||
|
You can use `withCondition` to conditionally load `plugin-bust`,
|
||||||
|
or you are free to instead create and use your own condition method
|
||||||
|
to pass along with the plugin.
|
||||||
|
|
||||||
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-bust
|
||||||
|
|
||||||
[2]: https://github.com/freesewing/freesewing/blob/develop/designs/carlita/src/index.mjs#L25
|
[2]: https://github.com/freesewing/freesewing/blob/develop/designs/carlita/src/index.mjs#L25
|
||||||
|
|
||||||
[3]: https://github.com/freesewing/freesewing/blob/develop/designs/carlton
|
[3]: https://github.com/freesewing/freesewing/blob/develop/designs/carlton
|
||||||
|
|
||||||
[4]: https://github.com/freesewing/freesewing/blob/develop/designs/teagan/src/index.mjs
|
[4]: https://github.com/freesewing/freesewing/blob/develop/designs/teagan/src/index.mjs
|
||||||
|
|
||||||
|
|
|
@ -24,9 +24,15 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { buttonsPlugin } from '@freesewing/plugin-buttons'
|
||||||
|
// or
|
||||||
|
import { pluginButtons } from '@freesewing/plugin-buttons'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The buttons plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The buttons plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-buttons
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-buttons
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-cutonfold
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-cutonfold][1], this plugin provides [the
|
Published as [@freesewing/plugin-cutonfold][1], this plugin provides [the
|
||||||
cutonfold macro](/reference/macros/cutonfold) which adds a cut-on-fold
|
cutonfold macro](/reference/macros/cutonfold) which adds a _cut on fold_
|
||||||
indicator to your design.
|
indicator to your design.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
@ -18,9 +18,15 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { cutonfoldPlugin } from '@freesewing/plugin-cutonfold'
|
||||||
|
// or
|
||||||
|
import { pluginCutonfold } from '@freesewing/plugin-cutonfold'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The cutonfold plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The cutonfold plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-cutonfold
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-cutonfold
|
||||||
|
|
||||||
|
|
|
@ -24,9 +24,15 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { dimensionPlugin } from '@freesewing/plugin-dimension'
|
||||||
|
// or
|
||||||
|
import { pluginDimension } from '@freesewing/plugin-dimension'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The dimension plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The dimension plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-dimension
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-dimension
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,28 @@ FreeSewing uses a modular approach where functionality can be extended with
|
||||||
plugins. Plugins can provide macros, store methods, or use any of the lifecycle
|
plugins. Plugins can provide macros, store methods, or use any of the lifecycle
|
||||||
hooks.
|
hooks.
|
||||||
|
|
||||||
We maintain the following plugins:
|
## Using plugins
|
||||||
|
|
||||||
|
Plugins can be either
|
||||||
|
[added to part configurations](/reference/api/part/config/plugins) in designs or
|
||||||
|
[added to a pattern instance with Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import a plugin for use:
|
||||||
|
```js
|
||||||
|
import { namePlugin } from { @freesewing/plugin-name }
|
||||||
|
// or
|
||||||
|
import { pluginName } from { @freesewing/plugin-name }
|
||||||
|
```
|
||||||
|
|
||||||
|
<Tip>
|
||||||
|
|
||||||
|
For convenience, each plugin is exported in two name formats:
|
||||||
|
"plugin\<Name>" and "\<name\>Plugin".
|
||||||
|
For example, either `pluginBanner` or `bannerPlugin` can be used.
|
||||||
|
|
||||||
|
</Tip>
|
||||||
|
|
||||||
|
## Plugins we maintain
|
||||||
|
|
||||||
<ReadMore />
|
<ReadMore />
|
||||||
|
|
||||||
|
|
|
@ -19,5 +19,11 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-flip
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { flipPlugin } from '@freesewing/plugin-flip'
|
||||||
|
// or
|
||||||
|
import { pluginFlip } from '@freesewing/plugin-flip'
|
||||||
|
```
|
||||||
|
|
||||||
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-flip
|
||||||
|
|
|
@ -8,7 +8,7 @@ segments](https://en.wikipedia.org/wiki/Gore_\(segment\)); 2D panels to create
|
||||||
a sphehrical shape as used in hats for example.
|
a sphehrical shape as used in hats for example.
|
||||||
|
|
||||||
This plugin handles all the mathematics to create a (part-)sphere in your
|
This plugin handles all the mathematics to create a (part-)sphere in your
|
||||||
patterns.
|
designs.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -22,5 +22,11 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-gore
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { gorePlugin } from '@freesewing/plugin-gore'
|
||||||
|
// or
|
||||||
|
import { pluginGore } from '@freesewing/plugin-gore'
|
||||||
|
```
|
||||||
|
|
||||||
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-gore
|
||||||
|
|
|
@ -18,9 +18,15 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { grainlinePlugin } from '@freesewing/plugin-grainline'
|
||||||
|
// or
|
||||||
|
import { pluginGrainline } from '@freesewing/plugin-grainline'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The grainline plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The grainline plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-grainline
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-grainline
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,8 @@ title: plugin-i18n
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-i18n][1], this plugin faciliates
|
Published as [@freesewing/plugin-i18n][1], this plugin faciliates
|
||||||
translation of your designs.
|
translation of your designs by allowing you to provide your own
|
||||||
|
language translations.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -17,30 +18,52 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { i18nPlugin } from '@freesewing/plugin-i18n'
|
||||||
|
// or
|
||||||
|
import { pluginI18n } from '@freesewing/plugin-i18n'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
This plugin provides the mechanism for translation, but does not come with
|
This plugin provides the mechanism for translation but does not come with
|
||||||
translations itself. For this, you can use our [i18n
|
translations itself. For this, you can use our [i18n
|
||||||
package](/reference/packages/i18n).
|
package](https://www.npmjs.com/package/@freesewing/i18n).
|
||||||
|
|
||||||
To add (your own) translations, you should pass data to this plugin.
|
To add your own translations, you will need to pass data to this plugin
|
||||||
It should be structured as such:
|
containing translation keys and the translations for them for each language.
|
||||||
|
The data should be in the form of an `Object` structured as such:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
{
|
{
|
||||||
strings:
|
strings:
|
||||||
en: {
|
en: {
|
||||||
example: "Example"
|
example: "Example",
|
||||||
|
examplePhrase: "An example phrase",
|
||||||
|
anotherTranslationKey: "(English translation for the translation key)",
|
||||||
|
// More translations can follow...
|
||||||
},
|
},
|
||||||
nl: {
|
nl: {
|
||||||
example: "Voorbeeld"
|
example: "Voorbeeld",
|
||||||
|
examplePhrase: "Een voorbeeldzin",
|
||||||
|
anotherTranslationKey: "(Dutch translation for the translation key)",
|
||||||
|
// More translations can follow...
|
||||||
},
|
},
|
||||||
// More languages can follow
|
es: {
|
||||||
|
example: "Ejemplo",
|
||||||
|
examplePhrase: "Una frase de ejemplo",
|
||||||
|
anotherTranslationKey: "(Spanish translation for the translation key)",
|
||||||
|
// More translations can follow...
|
||||||
|
},
|
||||||
|
// More languages can follow...
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The i18n plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
<Related compact>
|
||||||
|
To learn more about using translations in a design, see the
|
||||||
|
[Translation guide](/guides/translation/)
|
||||||
|
</Related>
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-i18n
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-i18n
|
||||||
|
|
||||||
|
|
|
@ -18,6 +18,13 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { logoPlugin } from '@freesewing/plugin-logo'
|
||||||
|
// or
|
||||||
|
import { pluginLogo } from '@freesewing/plugin-logo'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The logo plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The logo plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-measurements
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-measurements][1], this plugin will
|
Published as [@freesewing/plugin-measurements][1], this plugin will
|
||||||
provide a number of extra measurements to your pattern insofar as
|
provide a number of extra measurements to your design insofar as
|
||||||
they can be deduced from the measurements that are provided.
|
they can be deduced from the measurements that are provided.
|
||||||
|
|
||||||
It will add the following measurements:
|
It will add the following measurements:
|
||||||
|
@ -14,7 +14,12 @@ It will add the following measurements:
|
||||||
- `waistFront` (if both `waist` and `waistBack` are provided)
|
- `waistFront` (if both `waist` and `waistBack` are provided)
|
||||||
- `waistBackArc` (if both `waist` and `waistBack` are provided)
|
- `waistBackArc` (if both `waist` and `waistBack` are provided)
|
||||||
- `waistFrontArc` (if both `waist` and `waistBack` are provided)
|
- `waistFrontArc` (if both `waist` and `waistBack` are provided)
|
||||||
- `crossSeamBack` (if both `crossSeam` and `crossSeamFront` are available)
|
- `crossSeamBack` (if both `crossSeam` and `crossSeamFront` are provided)
|
||||||
|
|
||||||
|
<Related compact>
|
||||||
|
For more information about these extra measurements, please see
|
||||||
|
[Measurements from `plugin-measurements`](/reference/measurements#measurements-from-plugin-measurements)
|
||||||
|
</Related>
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -28,6 +33,13 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { measurementsPlugin } from '@freesewing/plugin-measurements'
|
||||||
|
// or
|
||||||
|
import { pluginMeasurements } from '@freesewing/plugin-measurements'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The measurements plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The measurements plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
|
@ -18,6 +18,13 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { mirrorPlugin } from '@freesewing/plugin-mirror'
|
||||||
|
// or
|
||||||
|
import { pluginMirror } from '@freesewing/plugin-mirror'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The mirror plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The mirror plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
|
@ -18,6 +18,13 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { notchesPlugin } from '@freesewing/plugin-notches'
|
||||||
|
// or
|
||||||
|
import { pluginNotches } from '@freesewing/plugin-notches'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The notches plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The notches plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
|
@ -3,7 +3,7 @@ title: plugin-round
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-round][1], this plugin provides [the round
|
Published as [@freesewing/plugin-round][1], this plugin provides [the round
|
||||||
macro](/reference/macros/round) which helps you round corners on your
|
macro](/reference/macros/round) which helps you create rounded corners on your
|
||||||
designs.
|
designs.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
@ -18,12 +18,17 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { roundPlugin } from '@freesewing/plugin-round'
|
||||||
|
// or
|
||||||
|
import { pluginRound } from '@freesewing/plugin-round'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The round macro is intended for rounding 90° angles.
|
The `round` macro is intended for rounding 90° angles.
|
||||||
It does not support rounding other angles/corners.
|
It does not support rounding other angles/corners.
|
||||||
|
|
||||||
The round plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The round plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-round
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-round
|
||||||
|
|
||||||
|
|
|
@ -20,13 +20,19 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { scaleboxPlugin } from '@freesewing/plugin-scalebox'
|
||||||
|
// or
|
||||||
|
import { pluginScalebox } from '@freesewing/plugin-scalebox'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
This plugin by default includes FreeSewing branding, but you can
|
This plugin by default includes FreeSewing branding, but you can
|
||||||
override that when calling the scalebox macro in case you want to
|
override that when calling the `scalebox` macro in case you want to
|
||||||
generate your own branded designs.
|
generate your own branded designs.
|
||||||
|
|
||||||
The scalebox plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The scalebox plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-scalebox
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-scalebox
|
||||||
|
|
||||||
|
|
|
@ -19,6 +19,13 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { sprinklePlugin } from '@freesewing/plugin-sprinkle'
|
||||||
|
// or
|
||||||
|
import { pluginSprinkle } from '@freesewing/plugin-sprinkle'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The sprinkle plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The sprinkle plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
|
@ -3,7 +3,8 @@ title: plugin-svgattr
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-svgattr][1], this plugin takes an object of
|
Published as [@freesewing/plugin-svgattr][1], this plugin takes an object of
|
||||||
key-value pairs and adds them ass attributes to your SVG document on render.
|
key-value pairs and adds them as attributes of the `<svg>` tag
|
||||||
|
of a pattern's SVG document on render.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -17,11 +18,34 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { svgAttrPlugin } from '@freesewing/plugin-svgattr'
|
||||||
|
// or
|
||||||
|
import { svgattrPlugin } from '@freesewing/plugin-svgattr'
|
||||||
|
// or
|
||||||
|
import { pluginSvgAttr } from '@freesewing/plugin-svgattr'
|
||||||
|
// or
|
||||||
|
import { pluginSvgattr } from '@freesewing/plugin-svgattr'
|
||||||
|
```
|
||||||
|
<Tip>
|
||||||
|
For convenience, this plugin is exported
|
||||||
|
under multiple names with variations of capitalization.
|
||||||
|
</Tip>
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
You should pass a second argument which holds key-value pairs of the attributes
|
To provide the attributes for the `<svg>` tag, you will need to pass a
|
||||||
you want to add to the SVG tag.
|
second argument which holds key-value pairs.
|
||||||
|
It should be an `Object` structured as such:
|
||||||
|
|
||||||
The svgattr plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
```js
|
||||||
|
{
|
||||||
|
key1: 'value1',
|
||||||
|
key2: 'value2',
|
||||||
|
key3: 'value3',
|
||||||
|
// More key-value pairs can follow...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-svgattr
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-svgattr
|
||||||
|
|
|
@ -17,6 +17,13 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { themePlugin } from '@freesewing/plugin-theme'
|
||||||
|
// or
|
||||||
|
import { pluginTheme } from '@freesewing/plugin-theme'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
This plugin will inject CSS in the SVG document when rendering to SVG.
|
This plugin will inject CSS in the SVG document when rendering to SVG.
|
||||||
|
@ -24,7 +31,4 @@ This plugin will inject CSS in the SVG document when rendering to SVG.
|
||||||
If you use other ways to render your pattern (using `Pattern.getRenderProps()`)
|
If you use other ways to render your pattern (using `Pattern.getRenderProps()`)
|
||||||
you will need to apply your own styles.
|
you will need to apply your own styles.
|
||||||
|
|
||||||
The theme plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-theme
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-theme
|
||||||
|
|
||||||
|
|
|
@ -18,6 +18,13 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { titlePlugin } from '@freesewing/plugin-title'
|
||||||
|
// or
|
||||||
|
import { pluginTitle } from '@freesewing/plugin-title'
|
||||||
|
```
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
The title plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
The title plugin is part of our [plugin-bundle](/reference/plugins/bundle)
|
||||||
|
|
|
@ -1,11 +1,13 @@
|
||||||
---
|
---
|
||||||
title: versionfree-svg
|
title: plugin-versionfree-svg
|
||||||
---
|
---
|
||||||
|
|
||||||
Published as [@freesewing/plugin-versionfree-svg][1], this plugin suppresses
|
Published as [@freesewing/plugin-versionfree-svg][1], this plugin suppresses
|
||||||
the inclusion of the FreeSewing version number in SVG output. This allows
|
the inclusion of the FreeSewing version number in SVG output.
|
||||||
diffing pattern output between versions to check for any differences in the
|
This allows you to more easily check for differences in the
|
||||||
output between different versions of FreeSewing.
|
output of different pattern versions of the same design.
|
||||||
|
Without the plugin, false positives could be seen simply due to
|
||||||
|
differing FreeSewing version numbers.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -19,5 +21,11 @@ Either [add it as a part plugins](/reference/api/part/config/plugins) in your
|
||||||
design, or [add it to a pattern instance with
|
design, or [add it to a pattern instance with
|
||||||
Pattern.use()](/reference/api/pattern/use).
|
Pattern.use()](/reference/api/pattern/use).
|
||||||
|
|
||||||
[1]: https://www.npmjs.com/package/@freesewing/plugin-versionfree-svg
|
To import the plugin for use:
|
||||||
|
```js
|
||||||
|
import { versionfreeSvgPlugin } from '@freesewing/plugin-versionfree-svg'
|
||||||
|
// or
|
||||||
|
import { pluginVersionfreeSvg } from '@freesewing/plugin-versionfree-svg'
|
||||||
|
```
|
||||||
|
|
||||||
|
[1]: https://www.npmjs.com/package/@freesewing/plugin-versionfree-svg
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue