VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Updated Plugin docs for v3

Browse source
This commit is contained in:
Joost De Cock 2022-10-02 00:27:09 +02:00
parent 0374b04a59
commit d988f11062
24 changed files with 329 additions and 606 deletions
Download patch file Download diff file Expand all files Collapse all files

52
markdown/dev/reference/plugins/buttons/en.md
View file

@ -1,50 +1,32 @@
---
title: "@freesewing/plugin-buttons"
title: plugin-buttons
---
The **@freesewing/plugin-buttons** plugin provides the following [snippets](/reference/api/snippets):
Published as [@freesewing/plugin-buttons][1], this plugin provides the following
[snippets](/reference/snippets):
- [button](/reference/api/snippets/button)
- [buttonhole](/reference/api/snippets/buttonhole)
- [buttonhole-start](/reference/api/snippets/buttonhole-start)
- [buttonhole-end](/reference/api/snippets/buttonhole-end)
- [snap-stud](/reference/api/snippets/snap-stud)
- [snap-socket](/reference/api/snippets/snap-socket)
<Example part="plugin_buttons">
An example of the button, buttonhole, buttonhole-start, buttonhole-end, snap-stud, and snap-socket snippets
</Example>
<Tip>
The buttons plugin is part of our [plugin-bundle](/reference/plugins/bundle)
</Tip>
- [button](/reference/snippets/button)
- [buttonhole](/reference/snippets/buttonhole)
- [buttonhole-start](/reference/snippets/buttonhole-start)
- [buttonhole-end](/reference/snippets/buttonhole-end)
- [snap-stud](/reference/snippets/snap-stud)
- [snap-socket](/reference/snippets/snap-socket)
## Installation
```bash
```sh
npm install @freesewing/plugin-buttons
```
## Usage
Like all [build-time plugins](/guides/plugins/types-of-plugins#build-time-plugins), you
load them by passing them to the [freesewing.Design](/reference/api/design) super-constructor:
Either [add it as a part plugins](/reference/api/part/config/plugins) in your
design, or [add it to a pattern instance with
Pattern.use()](/reference/api/pattern/use).
```js
import freesewing from "@freesewing/core";
import buttons from "@freesewing/plugin-buttons";
import config from "../config";
## Notes
const Pattern = new freesewing.Design(config, buttons);
```
The buttons plugin is part of our [plugin-bundle](/reference/plugins/bundle)
[1]: https://www.npmjs.com/package/@freesewing/plugin-buttons
Now you can use the
[button](/reference/api/snippets/button),
[buttonhole](/reference/api/snippets/buttonhole),
[buttonhole-start](/reference/api/snippets/buttonhole-start),
[buttonhole-end](/reference/api/snippets/buttonhole-end),
[snap-stud](/reference/api/snippets/snap-stud), and
[snap-socket](/reference/api/snippets/snap-socket)
snippets in your designs.