1
0
Fork 0
freesewing/markdown/dev/reference/api/config/options/mm/en.md

53 lines
1.4 KiB
Markdown
Raw Normal View History

---
title: millimeter
---
2022-02-19 08:04:25 +01:00
While FreeSewing supports millimeter options, we recommend
using [percentage options][1] and will not accept
contributions that use millimeter options.
2022-02-05 17:44:23 +01:00
## Structure
A millimeter option should be a plain object with these properties:
2022-02-19 08:04:25 +01:00
- `mm` : The default value in millimeter
- `min` : The minimul that's allowed
- `max` : The maximum that's allowed
- `hide` <small>(optional)</small> : A method to [control the optional display of the option][hide]
2022-02-05 17:44:23 +01:00
[hide]: /reference/api/config/options#optionally-hide-options-by-configuring-a-hide-method
## Example
```js
options: {
elasticWidth: {
mm: 35,
min: 5,
max: 80
}
}
```
<Comment by="joost">
##### What's wrong with millimeter options?
2022-02-19 08:04:25 +01:00
Millimeter options do not scale.
Parametric design is the *raison d'être* of FreeSewing and that core belief
that things should seamlessly adapt goes out the window when you use a `mm`
option because now you have a value that will not change based on the
input measurements.
2022-02-19 08:04:25 +01:00
You could argue that it's fine because *you can just lower the option*
but that breaks the principle of *sensible defaults* (aka no surprises).
The fact that you can sidestep the bullet does not mean you're not creating
a footgun.
2022-02-19 08:04:25 +01:00
When you need a millimeter option, reach for a [snapped
percentage option][1] instead.
</Comment>
2022-02-05 17:44:23 +01:00
[1]: /reference/api/config/options/pct