FlexLayout is a layout manager that arranges React components in multiple tab sets, these can be resized and moved, much like the windowing system found in many IDE's.

More screenshots

Demo (light theme)

Demo (dark theme)

Available demo url parameters:

• reload=true - reload layout from file, rather than localstorage
• layout=sub - load a given layout (from file/localstorage)

Possible layout values:

• simple - a simple layout of 3 tabsets
• complex - a more complex layout with multiple tabsets
• preferred - shows tabsets with preferred sizes
• sub - shows a tab containing a sub layout

Example url with parameters:

https://rawgit.com/caplin/FlexLayout/demos/demos/v0.03/index.html?layout=simple&reload=true

Notes:

• this demo does not run in safari when hosted on github (something to do with loading files via XHR from github!)
• the demo js file is large because it is unminified.
• FlexLayout's only dependency is React

Features so far:

• splitters
• tabs
• tab dragging and ordering
• tabset dragging
• dock to tabset or edge
• maximize tabset
• tab overflow
• submodels, allow layouts inside layouts
• tab renaming
• themeing - light and dark
• lifecycle events
• touch events - works on mobile devices (iPad, Android)
• esc cancels drag
• add tabs using drag, indirect drag, add to active tabset, add to named tabset
• preferred pixel size tabsets
• headed tabsets
• tab and tabset attributes: enableHeader, enableTabStrip, enableDock, enableDrop...
• customizable tabs and tabset header rendering

todo:

• less styling
• more lifecycle events... beforeclose...
• full set of jasmine tests
• test in browsers/versions
• layout designer gui, drag and drop + set properties to design initial layout
• border dock layer (could be used for minimize to edge)

FlexLayout is in the npm repository. Simply install React and FlexLayout from npm:

npm install react --save
npm install react-dom --save
npm install flexlayout-react --save

Require React and FlexLayout in your modules:

var React = require("react");       
var ReactDOM = require("react-dom");
var FlexLayout = require("flexlayout-react");
var Layout = FlexLayout.Layout;
var Model = FlexLayout.Model;

Include the light or dark style in your html:

<link rel="stylesheet" href="node_modules/flexLayout-react/style/dark.css" />

##Usage

A single component <Layout> contains the tabsets and splitters. The <Layout> component takes the following props:

The model is tree of Node objects that define the structure of the layout. The model is created using the Model.fromJson(jsonObject) static method, and can be saved using the model.toJson() method.

The factory is a function that takes a Node object and returns a React component that should be hosted by a tab in the layout.

If the onAction prop is not specified then the layout will send the layout change action directly to the model.

var json = {
	global: {},
	layout:{ 
		"type": "row",
		"weight": 100,
		"children": [
			{
				"type": "tabset",
				"weight": 50,
				"selected": 0,
				"children": [
					{
						"type": "tab",
						"name": "FX",
						"component":"grid",
					}
				]
			},
			{
				"type": "tabset",
				"weight": 50,
				"selected": 0,
				"children": [
					{
						"type": "tab",
						"name": "FI",
						"component":"grid",
					}
				]
			}
		]
	}
};

var React = require("react");
var ReactDOM = require("react-dom");
var FlexLayout = require("flexlayout-react");
var Layout = FlexLayout.Layout;
var Model = FlexLayout.Model;

var model = Model.fromJson(json);

factory(node)
{
    var component = node.getComponent();
	if (component == "grid")
    {
			return <MyGrid node={node}/>
    }
}

render()
{
	<Layout model={model} factory={factory}/> 
}

The above code would render two tabsets horizontally each containing a single tab that hosts a grid component. The tabs could be moved and resized by dragging and dropping. Additional grids could be added to the layout by sending actions to the model.

The JSON model is built up using 3 types of 'node':

• row - rows contains a list of tabsets and child rows, the top level row will render horizontally, child rows will render in the opposite orientation to their parent.

• tabset - tabsets contain a list of tabs and the index of the selected tab

• tab - tabs specify the name of the component that they should host (that will be loaded via the factory) and the text of the actual tab.

Weights on rows and tabsets specify the relative weight of these nodes within the parent row, the actual values do not matter just their relative values (ie two tabsets of weights 30,70 would render the same if they had weights of 3,7).

Attributes allowed in the 'global' element

Attributes allowed in nodes of type 'row'.

Attributes allowed in nodes of type 'tab'.

Inherited defaults will take their value from the associated global attributes (see above).

Attributes allowed in nodes of type 'tabset'.

Inherited defaults will take their value from the associated global attributes (see above).

The Model accepts a set of actions via its doAction() method.

#Example

        this.props.model.doAction(Actions.updateModelAttributes({
            splitterSize:40,
            tabSetHeaderHeight:40,
            tabSetTabStripHeight:400
        }));

##Layout Component Methods to Create New Tabs

Methods on the Layout Component for adding tabs, the tabs are specified by their layout json.

Example:

this.refs.layout.addTabToTabSet("NAVIGATION", {component:"grid", name:"grid"});