1
0
Fork 0

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
This commit is contained in:
Joost De Cock 2021-08-25 16:09:31 +02:00
parent 1671a896b5
commit b34a2ee2ed
6132 changed files with 244167 additions and 0 deletions

View file

@ -0,0 +1,48 @@
---
title: Render
---
The `Render` component is componet that renders a FreeSewing pattern. It's an alternative to rendering patterns as SVG, allowing for more interactive use of our patterns in your frontend.
<Warning>
This component used to be named `Draft` but was renamed to `Render` to better
capture what the component does.
The name `Draft` is deprecated and will be removed in a future release.
</Warning>
## Example
![Screenshot of the component](example.png)
## Props
| Name | Type | Default | Description |
| --------------:|:----------:|:-------:|:----------------------------------------------- |
| *design* | `bool` | `false` | Whether or not to enable design mode |
| *style* | `object` | `{}` | Optional extra CSS for the SVG |
| *focus* | `string` | | The element to be in focus in design mode |
| *raiseEvent* | `function` | | A method to pass events to the parent component |
| *width* (*) | `number` | | The SVG width |
| *height* (*) | `number` | | The SVG height |
| *settings* (*) | `object` | | The [draft settings](/reference/settings/) |
| *parts* (*) | `object` | | An object holding the drafted parts |
<Note>
###### (*) Use `pattern.getRenderProps()` to get these props
The `width`, `height`, `settings`, and `parts` props are provided by the
[getRenderProps()](/reference/api/pattern/#getrenderprops) method of
the [Pattern](/reference/api/pattern/) object.
They are typically uses as in the example below:
```js
<Render {...pattern.getRenderProps()} />
```
</Note>

View file

@ -0,0 +1,49 @@
---
title: Render
---
The `Render` component is componet that renders a FreeSewing pattern.
It's an alternative to rendering patterns as SVG, allowing for more
interactive use of our patterns in your frontend.
<Warning>
This component used to be named `Draft` but was renamed to `Render` to better
capture what the component does.
The name `Draft` is deprecated and will be removed in a future release.
</Warning>
## Example
![Screenshot of the component](example.png)
## Props
| Name | Type | Default | Description |
|-------------:|:----------:|:-------:|:------------|
| *design* | `bool` | `false` | Whether or not to enable design mode |
| *style* | `object` | `{}` | Optional extra CSS for the SVG |
| *focus* | `string` | | The element to be in focus in design mode |
| *raiseEvent* | `function` | | A method to pass events to the parent component |
| *width* (*) | `number` | | The SVG width |
| *height* (*) | `number` | | The SVG height |
| *settings* (*)| `object` | | The [draft settings](/reference/settings/)|
| *parts* (*) | `object` | | An object holding the drafted parts |
<Note>
###### (*) Use `pattern.getRenderProps()` to get these props
The `width`, `height`, `settings`, and `parts` props are provided by the
[getRenderProps()](/reference/api/pattern/#getrenderprops) method of
the [Pattern](/reference/api/pattern/) object.
They are typically uses as in the example below:
```js
<Render {...pattern.getRenderProps()} />
```
</Note>

View file

@ -0,0 +1,48 @@
---
title: Render
---
The `Render` component is componet that renders a FreeSewing pattern. It's an alternative to rendering patterns as SVG, allowing for more interactive use of our patterns in your frontend.
<Warning>
This component used to be named `Draft` but was renamed to `Render` to better
capture what the component does.
The name `Draft` is deprecated and will be removed in a future release.
</Warning>
## Example
![Screenshot of the component](example.png)
## Props
| Name | Type | Default | Description |
| --------------:|:----------:|:-------:|:----------------------------------------------- |
| *design* | `bool` | `false` | Whether or not to enable design mode |
| *style* | `object` | `{}` | Optional extra CSS for the SVG |
| *focus* | `string` | | The element to be in focus in design mode |
| *raiseEvent* | `function` | | A method to pass events to the parent component |
| *width* (*) | `number` | | The SVG width |
| *height* (*) | `number` | | The SVG height |
| *settings* (*) | `object` | | The [draft settings](/reference/settings/) |
| *parts* (*) | `object` | | An object holding the drafted parts |
<Note>
###### (*) Use `pattern.getRenderProps()` to get these props
The `width`, `height`, `settings`, and `parts` props are provided by the
[getRenderProps()](/reference/api/pattern/#getrenderprops) method of
the [Pattern](/reference/api/pattern/) object.
They are typically uses as in the example below:
```js
<Render {...pattern.getRenderProps()} />
```
</Note>

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

View file

@ -0,0 +1,48 @@
---
title: Render
---
The `Render` component is componet that renders a FreeSewing pattern. It's an alternative to rendering patterns as SVG, allowing for more interactive use of our patterns in your frontend.
<Warning>
This component used to be named `Draft` but was renamed to `Render` to better
capture what the component does.
The name `Draft` is deprecated and will be removed in a future release.
</Warning>
## Exemple
![Screenshot of the component](example.png)
## Props
| Name | Type | Défaut | Description |
| --------------:|:----------:|:-------:|:----------------------------------------------- |
| *design* | `bool` | `false` | Whether or not to enable design mode |
| *style* | `object` | `{}` | Optional extra CSS for the SVG |
| *focus* | `string` | | The element to be in focus in design mode |
| *raiseEvent* | `function` | | A method to pass events to the parent component |
| *width* (*) | `number` | | The SVG width |
| *height* (*) | `number` | | The SVG height |
| *settings* (*) | `object` | | The [draft settings](/reference/settings/) |
| *parts* (*) | `object` | | An object holding the drafted parts |
<Note>
###### (*) Use `pattern.getRenderProps()` to get these props
The `width`, `height`, `settings`, and `parts` props are provided by the
[getRenderProps()](/reference/api/pattern/#getrenderprops) method of
the [Pattern](/reference/api/pattern/) object.
They are typically uses as in the example below:
```js
<Render {...pattern.getRenderProps()} />
```
</Note>

View file

@ -0,0 +1,48 @@
---
title: Render
---
The `Render` component is componet that renders a FreeSewing pattern. It's an alternative to rendering patterns as SVG, allowing for more interactive use of our patterns in your frontend.
<Warning>
This component used to be named `Draft` but was renamed to `Render` to better
capture what the component does.
The name `Draft` is deprecated and will be removed in a future release.
</Warning>
## Example
![Screenshot of the component](example.png)
## Props
| Name | Type | Default | Description |
| --------------:|:----------:|:-------:|:----------------------------------------------- |
| *design* | `bool` | `false` | Whether or not to enable design mode |
| *style* | `object` | `{}` | Optional extra CSS for the SVG |
| *focus* | `string` | | The element to be in focus in design mode |
| *raiseEvent* | `function` | | A method to pass events to the parent component |
| *width* (*) | `number` | | The SVG width |
| *height* (*) | `number` | | The SVG height |
| *settings* (*) | `object` | | The [draft settings](/reference/settings/) |
| *parts* (*) | `object` | | An object holding the drafted parts |
<Note>
###### (*) Use `pattern.getRenderProps()` to get these props
The `width`, `height`, `settings`, and `parts` props are provided by the
[getRenderProps()](/reference/api/pattern/#getrenderprops) method of
the [Pattern](/reference/api/pattern/) object.
They are typically uses as in the example below:
```js
<Render {...pattern.getRenderProps()} />
```
</Note>