VSinerva/freesewing
1
0
Fork 0
Code Activity
freesewing/markdown/dev/reference/plugins/buttons/en.md

56 lines
1.7 KiB
Markdown
Raw Normal View History

Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
---
title: buttons
---
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
[![Build-time plugin](https://img.shields.io/badge/Type-build--time-purple.svg)](/plugins)
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
 
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
[![License: MIT](https://img.shields.io/npm/l/@freesewing/plugin-buttons.svg?label=License)](https://www.npmjs.com/package/@freesewing/plugin-buttons)
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
 
[![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)
 
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
[![Open issues tagged pkg:plugin-buttons](https://img.shields.io/github/issues/freesewing/freesewing/pkg:plugin-buttons.svg?label=Issues)](https://github.com/freesewing/freesewing/issues?q=is%3Aissue+is%3Aopen+label%3Apkg%3Aplugin-buttons)
The **buttons** plugin provides the following [snippets](/reference/snippets/):
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
- `button`
- `buttonhole`
- `buttonhole-start`
- `buttonhole-end`
- `snap-stud`
- `snap-socket`
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
<Example part="plugin_buttons" caption="An example of the button, buttonhole, buttonhole-start, buttonhole-end, snap-stud, and snap-socket snippets" design={false} />
```js
let { Point, snippets, Snippet } = part.shorthand();
snippets.button = new Snippet('button', new Point(40, 10));
snippets.buttonhole = new Snippet('buttonhole', new Point(80, 10));
```
<Tip>
The buttons plugin is part of our [plugin-bundle](/reference/plugins/bundle)
</Tip>
## Installation
```bash
npm install @freesewing/plugin-buttons
```
## Usage
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
Like all [build-time plugins](/guides/plugins/#build-time-plugins), you load them
feat: Flat import of markdown repo This is a flat (without history) import of (some of) the content from our markdown module. We've imported this without history because the repo contains our blog posts and showcases posts content prior to porting them to strapi. Since this contains many images, it would balloon the size of this repo to import the full history. Instead, please refer to the history of the (archived) markdown repo at: https://github.com/freesewing/markdown
2021-08-25 16:09:31 +02:00
by passing them to the [`freesewing.Design`](/reference/api#design) constructor:
```js
import freesewing from "@freesewing/core";
import buttons from "@freesewing/plugin-buttons";
import config from "../config";
const Pattern = new freesewing.Design(config, buttons);
```
Revert "chore: Linting for markdown and js" This reverts commit 1c92e0f655c1b34e4b1f6807914529cc4d82ff81.
2021-10-17 18:26:00 +02:00
Copy permalink