1
0
Fork 0
freesewing/sites/dev/docs/reference/api/part/config/measurements/readme.mdx
2024-09-29 07:14:59 +02:00

41 lines
915 B
Text

---
title: Part measurements
---
The `measurements` and `optionalMeasurements` properties on the
part configuration object list the part's required and optional
measurements respectively.
:::tip
You should only include what's required by the part itself, not its dependencies
:::
## measurements
The `measurements` property should hold the names of the measurements
that are required to draft the current part.
```js
const part = {
name: 'example.front',
measurements: ['head', 'chest'],
draft: ({ part }) => part,
}
```
## optionalMeasurements
The `optionalMeasurements` property should hold the names of the measurements
that are optional to draft the current part.
```js
import { pluginBust } from '@freesewing/plugin-bust'
const part = {
name: 'example.front',
plugins: [pluginBust],
measurements: ['head', 'chest'],
optionalMeasurements: ['highBust'],
draft: ({ part }) => part,
}
```