Skip to content

Commit 6aff9c7

Browse files
authored
Update README.md
1 parent 5d9a883 commit 6aff9c7

1 file changed

Lines changed: 29 additions & 37 deletions

File tree

README.md

Lines changed: 29 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,18 @@ The quickest way to get started is simply to provide `Dockable` with `View` chil
2323

2424
> 💡 Note, each `View` must have a unique id to avoid undefined behavior
2525
26-
```js
27-
function App() {
28-
return (
29-
<Dockable.Root orientation="row">
30-
<Dockable.View id="1" name="Tab 1">
31-
First View
32-
</Dockable.View>
33-
<Dockable.View id="2" name="Tab 2">
34-
Second View
35-
</Dockable.View>
36-
<Dockable.View id="3" name="Tab 3">
37-
Third View
38-
</Dockable.View>
39-
</Dockable.Root>
40-
);
41-
}
26+
```jsx
27+
<Dockable.Root orientation="row">
28+
<Dockable.View id="1" name="Tab 1">
29+
First View
30+
</Dockable.View>
31+
<Dockable.View id="2" name="Tab 2">
32+
Second View
33+
</Dockable.View>
34+
<Dockable.View id="3" name="Tab 3">
35+
Third View
36+
</Dockable.View>
37+
</Dockable.Root>
4238
```
4339
![image](https://github.com/user-attachments/assets/9358bb45-573a-4fe1-b033-3bb864035a8d)
4440

@@ -48,29 +44,25 @@ Child components are not intended to be dynamic or managed manually, instead the
4844

4945
You can compose the initial layout using `Panel` and `Window` components. Each nested Panel alternates between row and column layouts. Windows can contain multiple Views which are displayed as tabs. `Views` are automatically wrapped in a Window one isn't supplied
5046

51-
```js
52-
function App() {
53-
return (
54-
<Dockable.Root>
55-
<Dockable.View id="view-1" name="Left">
47+
```jsx
48+
<Dockable.Root>
49+
<Dockable.View id="view-1" name="Left">
50+
{/* view */}
51+
</Dockable.View>
52+
<Dockable.Panel size={3}>
53+
<Dockable.View id="view-2" name="Top">
54+
{/* view */}
55+
</Dockable.View>
56+
<Dockable.Window>
57+
<Dockable.View id="view-3" name="Tab 1">
5658
{/* view */}
5759
</Dockable.View>
58-
<Dockable.Panel size={3}>
59-
<Dockable.View id="view-2" name="Top">
60-
{/* view */}
61-
</Dockable.View>
62-
<Dockable.Window>
63-
<Dockable.View id="view-3" name="Tab 1">
64-
{/* view */}
65-
</Dockable.View>
66-
<Dockable.View id="view-4" name="Tab 2">
67-
{/* view */}
68-
</Dockable.View>
69-
</Dockable.Window>
70-
</Dockable.Panel>
71-
</Dockable.Root>
72-
);
73-
}
60+
<Dockable.View id="view-4" name="Tab 2">
61+
{/* view */}
62+
</Dockable.View>
63+
</Dockable.Window>
64+
</Dockable.Panel>
65+
</Dockable.Root>
7466
```
7567
![image](https://github.com/user-attachments/assets/2979b900-950d-4a2b-a6c3-a2206e2a7055)
7668

0 commit comments

Comments
 (0)