VSinerva/freesewing
1
0
Fork 0
Code Activity

fix(docs): Update plugins documentation

Browse source
This commit is contained in:
Benjamin F 2022-12-13 04:39:07 -08:00
parent 7063d8ab9f
commit 767d835cc6
23 changed files with 272 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

32
markdown/dev/reference/plugins/svgattr/en.md
View file

@ -3,7 +3,8 @@ title: plugin-svgattr
---
Published as [@freesewing/plugin-svgattr][1], this plugin takes an object of
key-value pairs and adds them ass attributes to your SVG document on render.
key-value pairs and adds them as attributes of the `<svg>` tag
of a pattern's SVG document on render.
## Installation
@ -17,11 +18,34 @@ 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).
To import the plugin for use:
```js
import { svgAttrPlugin } from '@freesewing/plugin-svgattr'
// or
import { svgattrPlugin } from '@freesewing/plugin-svgattr'
// or
import { pluginSvgAttr } from '@freesewing/plugin-svgattr'
// or
import { pluginSvgattr } from '@freesewing/plugin-svgattr'
```
<Tip>
For convenience, this plugin is exported
under multiple names with variations of capitalization.
</Tip>
## Notes
You should pass a second argument which holds key-value pairs of the attributes
you want to add to the SVG tag.
To provide the attributes for the `<svg>` tag, you will need to pass a
second argument which holds key-value pairs.
It should be an `Object` structured as such:
The svgattr plugin is part of our [plugin-bundle](/reference/plugins/bundle)
```js
{
key1: 'value1',
key2: 'value2',
key3: 'value3',
// More key-value pairs can follow...
}
```
[1]: https://www.npmjs.com/package/@freesewing/plugin-svgattr