freesewing/packages/plugin-flip/README.md

<p align="center">
  <a title="Go to freesewing.org" href="https://freesewing.org/"><img src="https://freesewing.org/img/logo/black.svg" align="center" width="150px" alt="Freesewing logo"/></a>
</p>
<h4 align="center"><em>&nbsp;<a title="Go to freesewing.org" href="https://freesewing.org/">freesewing</a></em>
<br><sup>a library for made-to-measure sewing patterns</sup>
</h4>
<p align="center">
  <a href="https://travis-ci.org/freesewing/plugin-flip"><img src="https://badgen.net/travis/freesewing/plugin-flip/master" alt="Travis build"></a>
  <a href="https://www.npmjs.com/package/@freesewing/plugin-flip"><img src="https://badgen.net/npm/v/@freesewing/plugin-flip" alt="Version"></a>
  <a href="https://www.npmjs.com/package/@freesewing/plugin-flip"><img src="https://badgen.net/npm/license/@freesewing/plugin-flip" alt="License"></a>
  <a href="https://codecov.io/gh/freesewing/plugin-flip"><img src="https://badgen.net/codecov/c/github/freesewing/plugin-flip/master" alt="Code coverage"></a>
  <a href="https://deepscan.io/dashboard#view=project&pid=3267&bid=27574"><img src="https://deepscan.io/api/projects/3267/branches/27574/badge/grade.svg" alt="DeepScan grade"></a>
  <a href="https://gitter.im/freesewing/freesewing"><img src="https://badgen.net/badge/chat/on%20Gitter/cyan" alt="Chat on Gitter"></a>
  <a href="https://freesewing.org/patrons/join"><img src="https://badgen.net/badge/become/a%20Patron/FF5B77" alt="Become a Patron"></a>
</p>

# plugin-flip

A freesewing plugin to flip a part around the Y-axis (mirror it horizontally).

## Install

Install this plugin from NPM:

```sh
npm install --save @freesewing/plugin-flip
```

## Usage

To load this plugin, add it to your instantiated pattern:

```js
import pattern from '@freesewing/pattern-brian'
import theme from '@freesewing/plugin-theme'
import flip from '@freesewing/plugin-flip'

pattern.with(theme).with(flip);
```

You now have the `flip` macro available:

```js
macro("flip");
```

This macro will:

 - For all the points in your part, it will multiply their X-value by -1
 - For all the snippets in your part, it will multiply the X-value of their anchor point by -1
 - For all the paths in your part, and for each point the path uses, it will multiply its X-value by -1

## Where to get help

Questions? Stuck? The [freesewing chat room on Gitter](https://gitter.im/freesewing/freesewing)
is the best place to ask for help.