fix(docs): Update plugins documentation
This commit is contained in:
parent
7063d8ab9f
commit
767d835cc6
23 changed files with 272 additions and 51 deletions
|
@ -5,7 +5,7 @@ title: plugin-bust
|
|||
Published as [@freesewing/plugin-bust][1], this plugin helps you adapt menswear
|
||||
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
|
||||
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.
|
||||
|
||||
## 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
|
||||
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
|
||||
|
||||
|
@ -37,7 +48,7 @@ womenswear pattern for a person with above-average sized breasts.
|
|||
This plugin helps you by:
|
||||
|
||||
- Storing the chest circumference in `measurements.bust`
|
||||
- Changing `measurments.chestCircumference` to the value of
|
||||
- Changing `measurments.chest` to the value of
|
||||
`measurements.highBust`
|
||||
|
||||
### 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
|
||||
breasts.
|
||||
|
||||
You can see this in practice in our [Carlita][2] pattern, which extends the
|
||||
menswear [Carlton][3] pattern.
|
||||
You can see this in practice in our [Carlita][2] design, which extends the
|
||||
menswear [Carlton][3] design.
|
||||
|
||||
<Related compact>
|
||||
To learn more about extending a pattern, see [Part
|
||||
To learn more about extending a design, see [Part
|
||||
inheritance](/howtos/code/from/)
|
||||
</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
|
||||
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)
|
||||
- You'll need to [conditionally load this
|
||||
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].
|
||||
|
||||
[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
|
||||
|
||||
[3]: https://github.com/freesewing/freesewing/blob/develop/designs/carlton
|
||||
|
||||
[4]: https://github.com/freesewing/freesewing/blob/develop/designs/teagan/src/index.mjs
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue