1
0
Fork 0

Merge pull request #5995 from BenJamesBen/part-docs-update

fix(markdown): In Part doc, add properties and methods
This commit is contained in:
Joost De Cock 2024-02-10 14:23:24 +01:00 committed by GitHub
commit 60c5f652cd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 37 additions and 1 deletions

View file

@ -7,6 +7,27 @@ Parts truly are the building blocks of FreeSewing as they not only provide
the configuration, but also a `draft()` method that does the actual work
of drafting a parametric design.
## Properties
A Part object comes with the following properties:
- `attributes` : An [Attributes](/reference/api/attributes) instance holding
the part's attributes
- `hidden` : When this is `true` the part will be hidden (excluded it from the
output). See [Part.hide()](/reference/api/part/hide),
[Part.unhide()](/reference/api/part/unhide), and
[Part.setHidden()](/reference/api/part/sethidden) for various methods that
allow setting this in a chainable way.
- `name` : The name of the part
- `paths` : Holds the paths used in the part
- `points` : Holds the points used in the part
- `snippets` : Holds the snippets used in the part
<Related>
See [Using Attributes](/howtos/code/attributes)
for information about custom Attributes that can be used with Parts.
</Related>
## Example
```js
@ -31,6 +52,21 @@ const part = {
}
```
## Methods
A Part object exposes the following methods:
- [Part.asRenderProps()](/reference/api/part/asrenderprops)
- [Part.attr()](/reference/api/part/attr)
- [Part.getId()](/reference/api/part/getid)
- [Part.hide()](/reference/api/part/hide)
- [Part.setHidden()](/reference/api/part/sethidden)
- [Part.shorthand()](/reference/api/part/shorthand)
- [Part.unhide()](/reference/api/part/unhide)
- [Part.units()](/reference/api/part/units)
## More information
Click below to learn more about:
- [A part's configuration](/reference/api/part/config)