ab3204f9f1
The replaces the NextJS site powering FreeSewing.dev with a Docusaurus setup. It's part of my efforts to simplify FreeSewing's setup so we can focus on our core value proposition.
29 lines
1,005 B
Text
29 lines
1,005 B
Text
---
|
|
title: Pattern.getRenderProps()
|
|
---
|
|
|
|
The `Pattern.getRenderProps()` method will return an object that
|
|
facilitates rendering the pattern by an external renderer such as
|
|
our [Pattern React component](/reference/packages/react-components).
|
|
It should only be called after calling `Pattern.draft()`.
|
|
|
|
## Pattern.getRenderProps() signature
|
|
|
|
```js
|
|
Object pattern.getRenderProps()
|
|
```
|
|
|
|
## Returned object properties
|
|
|
|
The `Pattern.getRenderProps()` method returns an object with
|
|
the following properties:
|
|
|
|
| Property | Description |
|
|
| --------:| ----------- |
|
|
| `autoLayout` | An object describing the (automated) pattern layout |
|
|
| `height` | Height of the drafted pattern in `mm` |
|
|
| `width` | Width of the drafted pattern in `mm` |
|
|
| `settings` | The (sets of) settings used to draft the pattern |
|
|
| `stacks` | A plain object holding the drafted stacks |
|
|
| `svg` | The [Svg Object](/reference/api/svg/) object with the `preRender` hook applied as [Svg.asRenderProps()](/reference/api/svg/asrenderprops) |
|
|
|