Skip to content

Commit a6d7825

Browse files
authored
Update README.md
1 parent c653227 commit a6d7825

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
![NPM](https://img.shields.io/npm/v/react-spaces.svg) ![Azure Pipelines](https://allan-eagle.visualstudio.com/All%20projects/_apis/build/status/aeagle.react-spaces?branchName=master)
44

5-
React Spaces allow you to divide a page or container HTML element into spaces. These spaces know how to behave in relation to each other and can also be divided into further nested spaces.
5+
An easy to understand and nestable layout system, React Spaces allow you to divide a page or container into anchored, scrollable and resizable spaces enabling you to build desktop/mobile type user interfaces in the browser. Spaces are intended to be the reusable foundational blocks for laying out a UI.
6+
7+
- No styling to achieve simple or complex layouts.
8+
- Spaces know how to behave in relation to each other and resize accordingly.
9+
- Spaces don't have any visual element to them (even padding or margins). You can fill them with whatever you want.
610

711
**Version 0.2.0 release - read [release notes here](https://www.allaneagle.com/react-spaces/release-0.2.0).**
812

@@ -48,11 +52,12 @@ Layers allow you to create layers within a parent space, for example:
4852

4953
```html
5054
<ViewPort>
51-
<Layer zIndex="{0}"> <LeftResizable size="20%" /> // floating sidebar </Layer>
52-
53-
<Layer zIndex="{1}">
54-
<Fill />
55-
</Layer>
55+
<Layer zIndex="{0}">
56+
<LeftResizable size="20%" /> // floating sidebar
57+
</Layer>
58+
<Layer zIndex="{1}">
59+
<Fill />
60+
</Layer>
5661
</ViewPort>
5762
```
5863

0 commit comments

Comments
 (0)