fix(dev/docs): Add expand setting
This commit is contained in:
parent
f903929a0a
commit
19397c1c6e
3 changed files with 78 additions and 33 deletions
|
@ -14,7 +14,7 @@ The draft method receives a single parameter, an object which you can _destructu
|
||||||
access the following properties:
|
access the following properties:
|
||||||
|
|
||||||
| Property | Description |
|
| Property | Description |
|
||||||
| --------:|:----------- |
|
| ----------------: | :------------------------------------------------------------------------------------------------------------ |
|
||||||
| | **_Content constructors_** |
|
| | **_Content constructors_** |
|
||||||
| `Path` | A [Path constructor](/reference/api/path) to create new paths |
|
| `Path` | A [Path constructor](/reference/api/path) to create new paths |
|
||||||
| `Point` | A [Point constructor](/reference/api/point) to create new points |
|
| `Point` | A [Point constructor](/reference/api/point) to create new points |
|
||||||
|
@ -26,6 +26,7 @@ access the following properties:
|
||||||
| | **_Access to settings_** |
|
| | **_Access to settings_** |
|
||||||
| `absoluteOptions` | Access to `settings.absoluteOptions` |
|
| `absoluteOptions` | Access to `settings.absoluteOptions` |
|
||||||
| `complete` | Access to `settings.complete` |
|
| `complete` | Access to `settings.complete` |
|
||||||
|
| `expand` | Access to `settings.expand` |
|
||||||
| `measurements` | Access to `settings.measurements` |
|
| `measurements` | Access to `settings.measurements` |
|
||||||
| `options` | Access to `settings.options` |
|
| `options` | Access to `settings.options` |
|
||||||
| `paperless` | Access to `settings.paperless` |
|
| `paperless` | Access to `settings.paperless` |
|
||||||
|
|
44
sites/dev/docs/reference/settings/expand/readme.mdx
Normal file
44
sites/dev/docs/reference/settings/expand/readme.mdx
Normal file
|
@ -0,0 +1,44 @@
|
||||||
|
---
|
||||||
|
title: expand
|
||||||
|
---
|
||||||
|
|
||||||
|
The `expand` setting controls whether all parts should be fully
|
||||||
|
drawn in a pattern.
|
||||||
|
Set `expand` to `false` when the pattern should instead omit parts and/or
|
||||||
|
draw abbreviated parts.
|
||||||
|
|
||||||
|
Omitting parts and using abbreviated parts saves space and paper
|
||||||
|
in printed patterns.
|
||||||
|
Typically, this is done for parts that are simple shapes like
|
||||||
|
rectangles or that can be cut on the fold.
|
||||||
|
|
||||||
|
## Signature
|
||||||
|
|
||||||
|
```js
|
||||||
|
const settings = {
|
||||||
|
Boolean expand=true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The default `expand` setting is `true`.
|
||||||
|
Set this to `false` to draft a pattern with omitted or abbreviated parts,
|
||||||
|
rather than with fully-drawn parts.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { Aaron } from '@freesewing/aaron'
|
||||||
|
|
||||||
|
const pattern = new Aaron({
|
||||||
|
expand: false,
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
The `expand` setting does not automatically cause pattern parts to
|
||||||
|
be omitted or abbreviated.
|
||||||
|
Instead, it is up to the pattern designer to have the design
|
||||||
|
check for the `expand` setting,
|
||||||
|
include all, full parts if set to `true`,
|
||||||
|
and omit or abbreviate relevant parts if set to `false`.
|
|
@ -13,6 +13,7 @@ Object settings = {
|
||||||
Object absoluteOptions,
|
Object absoluteOptions,
|
||||||
Boolean complete=true,
|
Boolean complete=true,
|
||||||
Boolean embed=false,
|
Boolean embed=false,
|
||||||
|
Boolean expand=true,
|
||||||
String idPrefix='fs-',
|
String idPrefix='fs-',
|
||||||
Object|Boolean layout=true,
|
Object|Boolean layout=true,
|
||||||
String locale='en',
|
String locale='en',
|
||||||
|
@ -51,4 +52,3 @@ new pattern([
|
||||||
},
|
},
|
||||||
])
|
])
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue