Skip to content

Commit d3208d9

Browse files
committed
Added readme, LICENSE and CREDITS
1 parent 4878584 commit d3208d9

File tree

5 files changed

+57
-1
lines changed

5 files changed

+57
-1
lines changed

CREDITS

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
##Thanks to
2+
3+
### [react-split-pane](https://github.com/tomkp/react-split-pane)
4+
Styles and concept for split pane
5+
6+
### [react-layout](https://github.com/jsdf/react-layout)
7+
The naming and the behavior has been taken from this project

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2014 James Friend
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"test": "karma start --autowatch --no-single-run"
1111
},
1212
"author": "",
13-
"license": "ISC",
13+
"license": "MIT",
1414
"devDependencies": {
1515
"babel-core": "^5.2.3",
1616
"babel-loader": "^5.0.0",

readme.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## react-flex-layout
2+
react-flex-layout combines ideas from [react-split-pane](https://github.com/tomkp/react-split-pane) and [react-layout](https://github.com/jsdf/react-layout) into a single project which has good browser compatibility
3+
4+
### Usage
5+
```
6+
<Layout fill='window'>
7+
<Layout layoutWidth='flex'>Column1</Layout>
8+
<Layout layoutWidth={100}>Column2</Layout>
9+
</Layout>
10+
```
11+
12+
This will work as expected, the outer layout will fill the browser window exactly, the right panel will be fixed at 100px and the left panel will fill the rest. As the browser is resized the layouts will update.
13+
14+
If you want to allow the user to resize it is as simple as dropping a `<LayoutSplitter />` between the panels
15+
```
16+
<Layout>
17+
<Layout layoutWidth={100}>Column1</Layout>
18+
<LayoutSplitter />
19+
<Layout layoutWidth='flex'>Column2</Layout>
20+
</Layout>
21+
```
22+
23+
![Demo](readme1.gif)
24+
25+
### Compatibility
26+
- Chrome
27+
- FireFox
28+
- Internet explorer ? (untested...)

readme1.gif

251 KB
Loading

0 commit comments

Comments
 (0)