Skip to content

Commit d366ff4

Browse files
authored
[shuffle] Add an alignment attr to rows and containers (#34)
1 parent 7fd8e87 commit d366ff4

27 files changed

Lines changed: 117 additions & 37 deletions

packages/docs/content/docs/shuffle/reference/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ title: "@pitter-patter/shuffle"
1111
- [ShufflePluginOptions](/docs/shuffle/reference/interfaces/ShufflePluginOptions)
1212
- [ShufflePluginState](/docs/shuffle/reference/interfaces/ShufflePluginState)
1313

14+
## Type Aliases
15+
16+
- [ShuffleAlignment](/docs/shuffle/reference/type-aliases/ShuffleAlignment)
17+
1418
## Variables
1519

1620
- [container](/docs/shuffle/reference/variables/container)
@@ -24,6 +28,7 @@ title: "@pitter-patter/shuffle"
2428
- [DragHandle](/docs/shuffle/reference/functions/DragHandle)
2529
- [DragHandles](/docs/shuffle/reference/functions/DragHandles)
2630
- [ResizeHandles](/docs/shuffle/reference/functions/ResizeHandles)
31+
- [setShuffleAlignment](/docs/shuffle/reference/functions/setShuffleAlignment)
2732
- [setShuffleColumns](/docs/shuffle/reference/functions/setShuffleColumns)
2833
- [setShuffleZIndex](/docs/shuffle/reference/functions/setShuffleZIndex)
2934
- [shuffle](/docs/shuffle/reference/functions/shuffle)

packages/docs/content/docs/shuffle/reference/functions/DragHandle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ function DragHandle(props: DragHandleProps): Element;
99
```
1010

1111
Defined in:
12-
[components/DragHandles.tsx:109](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/components/DragHandles.tsx#L109)
12+
[components/DragHandles.tsx:109](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/components/DragHandles.tsx#L109)
1313

1414
## Parameters
1515

packages/docs/content/docs/shuffle/reference/functions/DragHandles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ function DragHandles(props: { handleComponent?: ComponentType<DragHandleProps> }
99
```
1010

1111
Defined in:
12-
[components/DragHandles.tsx:43](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/components/DragHandles.tsx#L43)
12+
[components/DragHandles.tsx:43](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/components/DragHandles.tsx#L43)
1313

1414
A React component that renders the drag handles. This component will render a drag handle for each
1515
node that the pointer is currently hovering over. It should be a descendant of the `ProseMirror`

packages/docs/content/docs/shuffle/reference/functions/ResizeHandles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ function ResizeHandles(props: {
1717
```
1818

1919
Defined in:
20-
[components/ResizeHandles.tsx:44](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/components/ResizeHandles.tsx#L44)
20+
[components/ResizeHandles.tsx:44](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/components/ResizeHandles.tsx#L44)
2121

2222
A React component that renders the resize handles. This component will render a single set of resize
2323
handles whenever the selection is within a resizable node. It should be a descendant of the

packages/docs/content/docs/shuffle/reference/functions/ShuffleSkeleton.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ function ShuffleSkeleton(props: { children: ReactNode }): Element;
99
```
1010

1111
Defined in:
12-
[components/Skeleton.tsx:22](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/components/Skeleton.tsx#L22)
12+
[components/Skeleton.tsx:22](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/components/Skeleton.tsx#L22)
1313

1414
A React component that renders the grid skeleton. This component must be rendered for resize and
1515
reposition behaviors to work correctly. The component should be a direct parent of the

packages/docs/content/docs/shuffle/reference/functions/addShuffleNodes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ function addShuffleNodes<Nodes, Marks>(
1414
```
1515

1616
Defined in:
17-
[schema.ts:93](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/schema.ts#L93)
17+
[schema.ts:111](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/schema.ts#L111)
1818

1919
Augments the provided schema with the row and container nodes, as well as adding the `shuffleStart`
2020
and `shuffleEnd` attributes to every node in the group `group`. The `content` argument should be a
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: setShuffleAlignment
3+
---
4+
5+
# Function: setShuffleAlignment()
6+
7+
```ts
8+
function setShuffleAlignment(
9+
pos: number,
10+
alignment: ShuffleAlignment,
11+
): (state: EditorState, dispatch?: (tr: Transaction) => void) => boolean;
12+
```
13+
14+
Defined in:
15+
[commands.ts:36](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/commands.ts#L36)
16+
17+
## Parameters
18+
19+
### pos
20+
21+
`number`
22+
23+
### alignment
24+
25+
[`ShuffleAlignment`](/docs/shuffle/reference/type-aliases/ShuffleAlignment)
26+
27+
## Returns
28+
29+
(`state`: `EditorState`, `dispatch?`: (`tr`: `Transaction`) => `void`) => `boolean`

packages/docs/content/docs/shuffle/reference/functions/setShuffleColumns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ function setShuffleColumns(
1313
```
1414

1515
Defined in:
16-
[commands.ts:6](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/commands.ts#L6)
16+
[commands.ts:7](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/commands.ts#L7)
1717

1818
## Parameters
1919

packages/docs/content/docs/shuffle/reference/functions/setShuffleZIndex.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ function setShuffleZIndex(
1212
```
1313

1414
Defined in:
15-
[commands.ts:23](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/commands.ts#L23)
15+
[commands.ts:24](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/commands.ts#L24)
1616

1717
## Parameters
1818

packages/docs/content/docs/shuffle/reference/functions/shuffle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ function shuffle(__namedParameters?: ShufflePluginOptions): Plugin<ShufflePlugin
99
```
1010

1111
Defined in:
12-
[plugin.ts:72](https://github.com/handlewithcarecollective/pitter-patter/blob/5f9831b289582242a2f8b7c6f9c1d64b034de5a9/packages/shuffle/src/plugin.ts#L72)
12+
[plugin.ts:72](https://github.com/handlewithcarecollective/pitter-patter/blob/9ec4cd60f040e2134c47209a80da4fdb85ebb21f/packages/shuffle/src/plugin.ts#L72)
1313

1414
A ProseMirror plugin factory. Manages decorations, state, and event listeners necessary for
1515
autogroup, reorder, and reposition behaviors.

0 commit comments

Comments
 (0)