1
0
Fork 0
freesewing/sites/dev/docs/reference/api/pattern/use/readme.mdx

39 lines
930 B
Text
Raw Normal View History

---
title: Pattern.use()
---
2022-09-20 18:09:28 +02:00
The `Pattern.use()` method will load a FreeSewing plugin.
Plugins are a way to extend a pattern's functionality.
For more details, refer to [the plugin guide](/guides/plugins/).
2021-09-25 17:05:18 +02:00
2024-09-29 07:14:59 +02:00
:::note
This method is chainable as it returns the Pattern object
:::
2021-09-25 17:05:18 +02:00
## Pattern.use() signature
```js
Pattern pattern.use(object plugin)
// or
Pattern pattern.use(object plugin, object plugin_data)
2022-02-19 08:04:25 +01:00
```
2021-09-25 17:05:18 +02:00
See [the plugin guide](/guides/plugins/) for details on how to structure
you plugin object.
2021-09-25 17:05:18 +02:00
## Pattern.use() example
2021-09-25 17:05:18 +02:00
```js
2024-09-29 07:14:59 +02:00
import { Aaron } from '@freesewing/aaron'
import { pluginTheme } from '@freesewing/plugin-theme'
// Load some public test measurements from the FreeSewing backend
const measurements = (
2024-09-29 07:14:59 +02:00
await (await fetch('https://backend3.freesewing.org/curated-sets/1.json')).json()
).measurements
const pattern = new Aaron({ measurements }).use(pluginTheme)
2021-09-25 17:05:18 +02:00
const svg = pattern.draft().render()
2022-02-19 08:04:25 +01:00
```