Skip to content

Commit 52288bc

Browse files
chore(website): minor docs fixes
1 parent a6e7ed6 commit 52288bc

6 files changed

Lines changed: 11 additions & 11 deletions

File tree

website/docs/allotment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ title: Allotment
1010
| Name | Type | Default | Description |
1111
| -------------------- | ---------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1212
| `defaultSizes` | `number[]` | | An array of initial sizes of the panes. If the sum of the sizes differs from the size of the container then the panes' sizes will be scaled proportionally. |
13-
| `maxSize` | `number` | | Maximum size of any pane. |
14-
| `minSize` | `number` | | Minimum size of any pane. |
13+
| `maxSize` | `number` | `Infinity` | Maximum size of any pane. |
14+
| `minSize` | `number` | `30` | Minimum size of any pane. |
1515
| `proportionalLayout` | `boolean` | `true` | Resize each view proportionally when resizing container. |
1616
| `separator` | `boolean` | `true` | Whether to render a separator between panes. |
1717
| `snap` | `boolean` | `false` | Enable snap to zero for all panes. |
1818
| `vertical` | `boolean` | `false` | Direction to split. If true then the panes will be stacked vertically, otherwise they will be stacked horizontally. |
19-
| `onReset` | `func` | | Callback that is fired whenever the user double clicks a sash |
19+
| `onReset` | `func` | | Callback that is fired whenever the user double clicks a sash. |
2020
| `onVisibleChange` | `func` | | Callback that is fired whenever the user changes the visibility of a pane by snapping. Note that this will only be called if the new value is different from the current `visible` prop on the Pane. |

website/docs/closable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Closable
99

1010
<iframe src="https://codesandbox.io/embed/closable-dhqlue?fontsize=14&hidenavigation=1&theme=dark"
1111
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
12-
title="Basic"
12+
title="Closable"
1313
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
1414
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
1515
></iframe>

website/docs/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ Allotment is available as an [npm package](https://www.npmjs.com/package/allotme
1010
To install and save in your package.json dependencies, run:
1111

1212
```sh
13-
// with npm
13+
# with npm
1414
npm install allotment
1515

16-
// with yarn
16+
# with yarn
1717
yarn add allotment
1818
```
1919

@@ -35,7 +35,7 @@ function App() {
3535
return (
3636
<Allotment>
3737
<div>Pane 1</div>
38-
<div>Pane 1</div>
38+
<div>Pane 2</div>
3939
</Allotment>
4040
);
4141
}
@@ -66,7 +66,7 @@ function App() {
6666
<div>Pane 1</div>
6767
</Allotment.Pane>
6868
<Allotment.Pane snap>
69-
<div>Pane 1</div>
69+
<div>Pane 2</div>
7070
</Allotment.Pane>
7171
</Allotment>
7272
);

website/docs/nested.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Nested
99

1010
<iframe src="https://codesandbox.io/embed/nested-68elg8?fontsize=14&hidenavigation=1&theme=dark"
1111
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
12-
title="Basic"
12+
title="Nested"
1313
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
1414
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
1515
></iframe>

website/docs/reset.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Reset
99

1010
<iframe src="https://codesandbox.io/embed/reset-omeznb?fontsize=14&hidenavigation=1&theme=dark"
1111
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
12-
title="Basic"
12+
title="Reset"
1313
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
1414
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
1515
></iframe>

website/docs/visible.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Visible
99

1010
<iframe src="https://codesandbox.io/embed/visible-rhz804?fontsize=14&hidenavigation=1&theme=dark"
1111
style={{width:"100%", height:"500px", border:0, borderRadius: "4px", overflow:"hidden"}}
12-
title="Basic"
12+
title="Visible"
1313
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
1414
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
1515
></iframe>

0 commit comments

Comments
 (0)