1
0
Fork 0
freesewing/markdown/dev/reference/plugins/svgattr/en.md
2022-12-13 04:39:07 -08:00

1.2 KiB

title
plugin-svgattr

Published as @freesewing/plugin-svgattr, this plugin takes an object of key-value pairs and adds them as attributes of the <svg> tag of a pattern's SVG document on render.

Installation

npm install @freesewing/plugin-svgattr

Usage

Either add it as a part plugins in your design, or add it to a pattern instance with Pattern.use().

To import the plugin for use:

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'
For convenience, this plugin is exported under multiple names with variations of capitalization.

Notes

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:

{
  key1: 'value1',
  key2: 'value2',
  key3: 'value3',
  // More key-value pairs can follow...
}