chore(markdown): Updated utils docs for v3
This commit is contained in:
parent
acf1b72c4c
commit
bc3b0cd770
23 changed files with 782 additions and 622 deletions
35
markdown/dev/reference/api/utils/pctbasedon/en.md
Normal file
35
markdown/dev/reference/api/utils/pctbasedon/en.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: utils.pctBasedOn()
|
||||
---
|
||||
|
||||
The `utils.pctBasedOn()` function is a helper function to be used when
|
||||
configuring [snapped percentage
|
||||
options](/reference/api/part/config/options/pct/snap).
|
||||
|
||||
|
||||
## Signature
|
||||
|
||||
```js
|
||||
object utils.pctBasedOn(String measurement)
|
||||
```
|
||||
|
||||
## Example
|
||||
|
||||
```js
|
||||
const options = {
|
||||
example: {
|
||||
pct: 12,
|
||||
min: 5,
|
||||
max: 18,
|
||||
snap: 3,
|
||||
...pctBasedOn('chest')
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
This will return an object with `toAbs` and `fromAbs` properties that calculate
|
||||
the option's absolute and relative values based on a measurment. Refer to
|
||||
[snapped percentage options](/reference/api/part/config/options/pct/snap) for
|
||||
more details.
|
Loading…
Add table
Add a link
Reference in a new issue