VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Restructuring dev docs

Browse source
This commit is contained in:
Joost De Cock 2021-12-27 17:33:49 +01:00
parent 9ef46c502a
commit d42d9a9377
114 changed files with 246 additions and 1462 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,18 +1,10 @@
---
title: svgattr
title: "@freesewing/plugin-svgattr"
---
[![Run-time plugin](https://img.shields.io/badge/Type-run--time-lime.svg)](/plugins)
 
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-svgattr.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-svgattr)
 
[![Code quality on DeepScan](https://deepscan.io/api/teams/2114/projects/2993/branches/23256/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=2114&pid=2993&bid=23256)
 
[![Open issues tagged pkg:plugin-svgattr](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-svgattr.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-svgattr)
The **svgattr** plugin takes an object of key-value pairs and adds them to the SVG tag on render.
It uses the [`preRender`](/plugins#preRender) hook to do so.
The **@freesewing/plugin-svgattr** plugin takes an object of key-value
pairs and adds them ass attributes to your SVG document on render.
It leverages [the preRender lifecycle hook](/reference/api/hooks/prerender) to do so.
## Installation
@ -22,16 +14,16 @@ npm install @freesewing/plugin-svgattr
## Usage
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
by passing them to the [`freesewing.Design`](/reference/api#design) constructor:
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:
```js
import Aaron from "@freesewing/aaron";
import i18n from "@freesewing/plugin-i18n";
import svgAttr from "@freesewing/plugin-svgattr";
import translations from "@freesewing/i18n";
const myAaron = new Aaron()
.use(i18nPlugin, { class: "freesewing draft" });
.use(svgAttr, { class: "freesewing pattern" });
```
You should pass a second argument which holds key-value pairs of the attributes you want to add to the SVG tag.