1
0
Fork 0

chore(markdown): Updated settings docs

This commit is contained in:
Joost De Cock 2021-12-28 21:07:45 +01:00
parent 6ccdef7258
commit 45ebd9e142
13 changed files with 119 additions and 51 deletions

View file

@ -2,16 +2,16 @@
title: layout
---
Allows you to control the way pattern parts are laid out on the pattern.
There are 3 scenarios:
The `layout` setting allows you to control the way pattern parts are
layed out on the pattern. There are 3 scenarios:
- layout is truthy: Do layout algorithmically
- layout is falsy: Do not do any layout apart from stacking all parts together
- layout is an object: Layout the parts as detailed in the layout object
- layout is truthy: Do layout algorithmically
- layout is falsy: Do not do any layout apart from stacking all parts together
- layout is an object: Layout the parts as detailed in the layout object
Let's look at each in detail:
##### layout is truthy
## layout is truthy
This is the default behaviour. Parts will be laid without overlap in
a space that's a small as possible.
@ -20,7 +20,7 @@ Don't expect miracles here.
It's one of those things humans are far better at than
computers.
##### layout is falsy
## layout is falsy
This will cause all parts to be laid out on top of each other.
@ -28,7 +28,7 @@ It is almost certainly not what you want, but having all parts piled
on top of each other in the top left corner can be a good starting
point for a custom layout.
##### layout is a layout object
## layout is a layout object
This allows you to control the layout by passing a layout object.
This object should be structures as such:
@ -62,11 +62,11 @@ For each part in the `parts` attribute of our layout object, there are 4 possibl
- flipX: Will flip/mirror the part horizontally
- flipY: Will flip/mirror the part vertically
<Note>
<Related>
It is a long-standing ambition of ours to build a layout component that allows
users to manually do the layout of their pattern.
Core already supports it, but building a React component for it is non-trivial.
</Note>
</Related>